Enum CircuitPurpose 

pub enum CircuitPurpose {
    General,
    Controller,
}

Purpose for a circuit.

Circuits can be created for different purposes, which affects how Tor uses them.

Example

use stem_rs::controller::CircuitPurpose;

let purpose = CircuitPurpose::General;
assert_eq!(purpose.to_string(), "general");

Variants

General

General purpose circuit for normal traffic

Controller

Circuit created and managed by a controller

Trait Implementations

impl Clone for CircuitPurpose

fn clone(&self) -> CircuitPurpose

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CircuitPurpose

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for CircuitPurpose

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CircuitPurpose

fn eq(&self, other: &CircuitPurpose) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CircuitPurpose

impl Eq for CircuitPurpose

impl StructuralPartialEq for CircuitPurpose