Struct GuardEvent 

pub struct GuardEvent {
    pub guard_type: GuardType,
    pub endpoint: String,
    pub endpoint_fingerprint: String,
    pub endpoint_nickname: Option<String>,
    pub status: GuardStatus,
    /* private fields */
}

Event indicating that guard relay status has changed.

Guard events track changes to the entry guards that Tor uses for the first hop of circuits. Entry guards are a security feature that limits the set of relays that can observe your traffic entering the Tor network.

Guard Types

Currently, only GuardType::Entry is used, representing entry guards.

Guard Status

Guards can have these statuses:

• GuardStatus::New - Newly selected as a guard
• GuardStatus::Up - Guard is reachable
• GuardStatus::Down - Guard is unreachable
• GuardStatus::Good - Guard confirmed as good
• GuardStatus::Bad - Guard marked as bad
• GuardStatus::Dropped - Guard removed from list

Example

use stem_rs::events::GuardEvent;
use stem_rs::GuardStatus;

fn handle_guard(event: &GuardEvent) {
    match event.status {
        GuardStatus::New => {
            println!("New guard: {} ({:?})",
                event.endpoint_fingerprint, event.endpoint_nickname);
        }
        GuardStatus::Down => {
            println!("Guard {} is down", event.endpoint_fingerprint);
        }
        GuardStatus::Dropped => {
            println!("Guard {} dropped", event.endpoint_fingerprint);
        }
        _ => {}
    }
}

See Also

• GuardType - Guard type values
• GuardStatus - Guard status values

Fields

guard_type: GuardType

Type of guard (currently only Entry).

endpoint: String

Full endpoint string (fingerprint with optional nickname).

endpoint_fingerprint: String

Relay fingerprint (40 hex characters).

endpoint_nickname: Option<String>

Relay nickname if available.

status: GuardStatus

Current status of the guard.

Implementations

impl GuardEvent

pub fn parse(content: &str) -> Result<Self, Error>

Parses a guard event from raw control protocol content.

Arguments

• content - The event content after the event type

Event Format

GuardType Endpoint Status

Where Endpoint is either a fingerprint or fingerprint=nickname.

Errors

Returns Error::Protocol if:

• Required fields are missing
• The guard type or status is unrecognized

Trait Implementations

impl Clone for GuardEvent

fn clone(&self) -> GuardEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuardEvent

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

Formats the value using the given formatter.

impl Event for GuardEvent

fn event_type(&self) -> EventType

Returns the type of this event.

fn raw_content(&self) -> &str

Returns the raw, unparsed content of the event.

fn arrived_at(&self) -> Instant

Returns the instant when this event was received.