Struct BinaryNinjaLayer 

pub struct BinaryNinjaLayer {
    pub target_mappings: Vec<(String, String)>,
    pub format_target: bool,
}

Subscribes to all spans and events emitted by tracing and forwards them to the core logging API.

Fields

target_mappings: Vec<(String, String)>

Rewrite mappings for the default target.

Example

Given the target “my_crate::commands::analyze” and the mapping (“my_crate”, “MyPlugin”) the target will be rewritten to “MyPlugin::commands::analyze”, assuming no other rewrites occur.

format_target: bool

Whether the default target should be formatted to be displayed in the “common” logger name format for Binary Ninja.

This formatting will only be applied when the target name is implicit. Explicitly provided target names will be preserved as-is.

Example

Given the target “my_crate::commands::analyze” the target will be rewritten to “MyCrate.Commands.Analyze”.

Implementations

impl BinaryNinjaLayer

pub fn new() -> Self

pub fn with_target_mapping(self, old: &str, new: &str) -> Self

Add a target mapping which will rewrite the old in the default target to new.

This is typically done when you have a plugin name that is verbose, and you wish to display it in the logs as something else.

pub fn with_format_target(self, formatted: bool) -> Self

Whether formatting of the default target should be applied when sending logs to the core.

impl BinaryNinjaLayer

pub fn rewrite_target(&self, target: String) -> String

Rewrite the target so that the logger name will be displayed in the common Binary Ninja format.

Trait Implementations

impl Clone for BinaryNinjaLayer

fn clone(&self) -> BinaryNinjaLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for BinaryNinjaLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for BinaryNinjaLayer

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

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_event(&self, event: &Event<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

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_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.