LogEvent

Struct LogEvent 

Source
pub struct LogEvent {
    pub runlevel: Runlevel,
    pub message: String,
    /* private fields */
}
Expand description

Tor logging event for receiving log messages from the Tor process.

These are the most visible kind of event since, by default, Tor logs at the NOTICE Runlevel to stdout. Log events allow controllers to receive and process Tor’s log output programmatically.

§Runlevels

Log events are categorized by severity:

§Event Types

Each runlevel corresponds to a separate event type:

  • DEBUG, INFO, NOTICE, WARN, ERR

§Example

use stem_rs::{EventType, Runlevel};
use stem_rs::events::LogEvent;

fn handle_log(event: &LogEvent) {
    match event.runlevel {
        Runlevel::Err | Runlevel::Warn => {
            eprintln!("[{}] {}", event.runlevel, event.message);
        }
        _ => {
            println!("[{}] {}", event.runlevel, event.message);
        }
    }
}

§See Also

Fields§

§runlevel: Runlevel

Severity level of the log message.

§message: String

The log message content.

Implementations§

Source§

impl LogEvent

Source

pub fn parse(runlevel: Runlevel, message: &str) -> Result<Self, Error>

Parses a log event from raw control protocol content.

§Arguments
  • runlevel - The severity level of the log message
  • message - The log message content
§Errors

This method currently does not return errors but returns Result for API consistency with other event parsers.

Trait Implementations§

Source§

impl Clone for LogEvent

Source§

fn clone(&self) -> LogEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LogEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Event for LogEvent

Source§

fn event_type(&self) -> EventType

Returns the type of this event. Read more
Source§

fn raw_content(&self) -> &str

Returns the raw, unparsed content of the event. Read more
Source§

fn arrived_at(&self) -> Instant

Returns the instant when this event was received. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.