Skip to main content

Log

Struct Log 

Source
pub struct Log {
    pub session_id: u64,
    pub time: Cow<'static, str>,
    pub level: LogLevel,
    pub component: Cow<'static, str>,
    pub description: String,
    pub format: LogFormat,
    pub attributes: BTreeMap<String, Value>,
}
Expand description

A structured log entry with a chainable builder API.

Fields use Cow<'static, str> and u64 where possible to minimize heap allocations on the ingestion hot path.

Construct via level shortcuts (Log::info, Log::error, …) or the generic Log::build. Dispatch with Log::fire.

Fields§

§session_id: u64

Monotonic counter assigned at build() time.

§time: Cow<'static, str>

Wall-clock timestamp. Populated at build time; override with .time().

§level: LogLevel

Severity level (INFO, ERROR, etc.).

§component: Cow<'static, str>

Originating service or module name. Defaults to "default".

§description: String

Human-readable message body.

§format: LogFormat

Output format applied during Display serialization.

§attributes: BTreeMap<String, Value>

Arbitrary key-value attributes for structured context.

Implementations§

Source§

impl Log

Source

pub fn log(&self)

Ingest this entry into the engine by cloning it.

Prefer fire(), which consumes self and avoids the clone. Use log() only when you need to retain the entry.

Source

pub fn info(description: &str) -> Self

Build an INFO-level log entry.

Source

pub fn warn(description: &str) -> Self

Build a WARN-level log entry.

Source

pub fn error(description: &str) -> Self

Build an ERROR-level log entry.

Source

pub fn debug(description: &str) -> Self

Build a DEBUG-level log entry.

Source

pub fn trace(description: &str) -> Self

Build a TRACE-level log entry.

Source

pub fn verbose(description: &str) -> Self

Build a VERBOSE-level log entry.

Source

pub fn fatal(description: &str) -> Self

Build a FATAL-level log entry.

Source

pub fn critical(description: &str) -> Self

Build a CRITICAL-level log entry.

Source

pub fn build(level: LogLevel, description: &str) -> Self

Build a log entry with an explicit level and description.

Assigns a monotonic session_id and captures the current wall-clock time. Defaults to LogFormat::MCP and component "default".

Source

pub fn time(self, time: &str) -> Self

Override the timestamp for this entry.

Source

pub const fn session_id(self, session_id: u64) -> Self

Override the auto-assigned session ID.

Source

pub fn with<T: Serialize>(self, key: &str, value: T) -> Self

Attach a key-value attribute. Accepts any T: Serialize.

Source

pub fn component(self, component: &str) -> Self

Tag the originating service or module.

Source

pub const fn format(self, format: LogFormat) -> Self

Set the output format for this entry.

Source

pub fn fire(self)

Consume this entry and push it into the ring buffer.

Cost: one Log move (~128 bytes). Serialization is deferred. Automatically captures file:line via #[track_caller]; the flusher adds it as the caller attribute.

Trait Implementations§

Source§

impl Clone for Log

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Log

Source§

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

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

impl Default for Log

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Log

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Log

Source§

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

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

impl Eq for Log

Source§

impl PartialEq for Log

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Log

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Log

Auto Trait Implementations§

§

impl Forget for Log

§

impl Freeze for Log

§

impl RefUnwindSafe for Log

§

impl Send for Log

§

impl Sync for Log

§

impl Unpin for Log

§

impl UnsafeUnpin for Log

§

impl UnwindSafe for Log

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.