Struct AddrMapEvent 

pub struct AddrMapEvent {
    pub hostname: String,
    pub destination: Option<String>,
    pub expiry: Option<DateTime<Local>>,
    pub error: Option<String>,
    pub utc_expiry: Option<DateTime<Utc>>,
    pub cached: Option<bool>,
    /* private fields */
}

Event indicating a new address mapping has been created.

Address map events are emitted when Tor creates a mapping between a hostname and its resolved address. This can occur due to DNS resolution, MAPADDRESS commands, or TrackHostExits configuration.

Expiration

Address mappings have an expiration time after which they are no longer valid. The expiry field contains the local time, while utc_expiry contains the UTC time (if available).

Caching

The cached field indicates whether the mapping will be kept until expiration (true) or may be evicted earlier (false).

Error Mappings

When DNS resolution fails, destination will be None and the error field will contain the error code.

Example

use stem_rs::events::AddrMapEvent;

fn handle_addrmap(event: &AddrMapEvent) {
    match &event.destination {
        Some(dest) => {
            println!("{} -> {} (expires: {:?})",
                event.hostname, dest, event.expiry);
        }
        None => {
            println!("Resolution failed for {}: {:?}",
                event.hostname, event.error);
        }
    }
}

Fields

hostname: String

The hostname being resolved.

destination: Option<String>

The resolved address, or None if resolution failed.

expiry: Option<DateTime<Local>>

Expiration time in local time.

error: Option<String>

Error code if resolution failed.

utc_expiry: Option<DateTime<Utc>>

Expiration time in UTC.

cached: Option<bool>

Whether the mapping is cached until expiration.

Implementations

impl AddrMapEvent

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

Parses an address map event from raw control protocol content.

Arguments

• content - The event content after the event type

Event Format

Hostname Destination Expiry [error=...] [EXPIRES="..."] [CACHED=YES|NO]

Errors

Returns Error::Protocol if required fields are missing.

Trait Implementations

impl Clone for AddrMapEvent

fn clone(&self) -> AddrMapEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddrMapEvent

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

Formats the value using the given formatter.

impl Event for AddrMapEvent

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.