Struct ScriptLogHandle 

pub struct ScriptLogHandle { /* private fields */ }

Handle for accessing and managing script logs captured during execution.

This structure provides a thread-safe interface for storing and retrieving log entries generated by Rhai scripts. It implements the tracing Layer trait to automatically capture relevant log events.

Implementations

impl ScriptLogHandle

pub fn new(max_script_log_message_length: usize, max_log_entries: usize) -> Self

Creates a new ScriptLogHandle with specified message length and max log entries limits

pub fn get_logs(&self) -> Vec<LogEntry>

Retrieves all captured script log entries.

This method returns a clone of all log entries that have been captured since the handle was created or last cleared. The returned vector contains entries in the order they were captured.

Returns

A Vec<LogEntry> containing all captured log entries. Returns an empty vector if no logs have been captured or if there was an error accessing the internal log storage.

pub fn was_max_limit_applied(&self) -> bool

Returns whether the maximum limit was applied and elements were removed.

This method checks if the bounded deque ever reached capacity and had to evict older entries to make room for new ones.

Returns

true if the limit was applied at least once, false otherwise.

Trait Implementations

impl Clone for ScriptLogHandle

fn clone(&self) -> ScriptLogHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptLogHandle

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

Formats the value using the given formatter.

impl Default for ScriptLogHandle

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for ScriptLogHandle

where S: Subscriber + for<'lookup> LookupSpan<'lookup>,

Implementation of the tracing Layer trait for ScriptLogHandle.

This implementation allows the script log handle to be used as a tracing layer, automatically capturing events that match the script log target and converting them into structured log entries.

fn on_event(&self, event: &Event<'_>, _ctx: Context<'_, S>)

Processes tracing events and captures those matching the script log target.

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a Subscriber.

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite.

fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled.

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>

where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer.

fn with_subscriber(self, inner: S) -> Layered<Self, S>

where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber.

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>

where Self: Sized, F: Filter<S>,

Combines self with a Filter, returning a Filtered layer.

fn boxed(self) -> Box<dyn Layer<S> + Sync + Send>

where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

Erases the type of this Layer, returning a Boxed dyn Layer trait object.