Struct SignalEvent 

pub struct SignalEvent {
    pub signal: Signal,
    /* private fields */
}

Event indicating that Tor received a signal.

This event is emitted when Tor receives a signal, either from the operating system or via the control protocol’s SIGNAL command.

Signals

Common signals include:

• Signal::Newnym - Request new circuits
• Signal::Reload - Reload configuration
• Signal::Shutdown - Graceful shutdown
• Signal::Halt - Immediate shutdown

Example

use stem_rs::events::SignalEvent;
use stem_rs::Signal;

fn handle_signal(event: &SignalEvent) {
    match event.signal {
        Signal::Newnym => println!("New identity requested"),
        Signal::Shutdown => println!("Tor is shutting down"),
        _ => println!("Received signal: {:?}", event.signal),
    }
}

See Also

• Signal - Signal types

Fields

signal: Signal

The signal that was received.

Implementations

impl SignalEvent

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

Parses a signal event from raw control protocol content.

Arguments

• content - The event content after the event type

Errors

Returns Error::Protocol if the signal is unrecognized.

Trait Implementations

impl Clone for SignalEvent

fn clone(&self) -> SignalEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalEvent

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

Formats the value using the given formatter.

impl Event for SignalEvent

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.