Struct StatusEvent 

pub struct StatusEvent {
    pub status_type: StatusType,
    pub runlevel: Runlevel,
    pub action: String,
    pub arguments: HashMap<String, String>,
    /* private fields */
}

Event providing status information about Tor’s operation.

Status events provide structured information about Tor’s operational state, including bootstrap progress, circuit establishment, and various warnings or errors.

Status Types

Events are categorized by type:

• StatusType::General - General status (e.g., consensus arrived)
• StatusType::Client - Client-specific status (e.g., bootstrap progress)
• StatusType::Server - Server-specific status (e.g., reachability checks)

Bootstrap Progress

The most common use of status events is tracking bootstrap progress. Look for action == "BOOTSTRAP" and check the PROGRESS argument.

Example

use stem_rs::events::StatusEvent;
use stem_rs::StatusType;

fn handle_status(event: &StatusEvent) {
    if event.action == "BOOTSTRAP" {
        if let Some(progress) = event.arguments.get("PROGRESS") {
            println!("Bootstrap progress: {}%", progress);
        }
        if let Some(summary) = event.arguments.get("SUMMARY") {
            println!("Status: {}", summary);
        }
    }
}

See Also

• StatusType - Status event types
• Runlevel - Severity levels

Fields

status_type: StatusType

Type of status event (General, Client, or Server).

runlevel: Runlevel

Severity level of the status message.

action: String

Action or event name (e.g., “BOOTSTRAP”, “CIRCUIT_ESTABLISHED”).

arguments: HashMap<String, String>

Key-value arguments providing additional details.

Implementations

impl StatusEvent

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

Parses a status event from raw control protocol content.

Arguments

• status_type - The type of status event
• content - The event content after the event type

Event Format

Runlevel Action [Key=Value ...]

Errors

Returns Error::Protocol if:

• Required fields are missing
• The runlevel is unrecognized

Trait Implementations

impl Clone for StatusEvent

fn clone(&self) -> StatusEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusEvent

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

Formats the value using the given formatter.

impl Event for StatusEvent

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.