Skip to main content

Scope

Struct Scope 

Source
pub struct Scope { /* private fields */ }
Expand description

Builds a set of scope fields.

§Examples

use ash_log::*;
use std::sync::Arc;

let logger = ash_logger!(backend: Arc::new(NoopAuditBackend));

let _scope = Scope::new()
    .correlation_id("req-7f3a")
    .principal("alice@example.com")
    .with("tenant", "acme")
    .enter();

// Both events carry the correlation ID, the principal, and `tenant`.
ash_info!(logger, "handling request");
ash_audit!(logger, MethodInvocation, Success, method = "transfer");

Implementations§

Source§

impl Scope

Source

pub fn new() -> Self

An empty scope. Entering it inherits the enclosing scope’s fields.

Source

pub fn correlation_id<S: Into<String>>(self, id: S) -> Self

Bind the correlation ID.

Source

pub fn principal<S: Into<String>>(self, principal: S) -> Self

Bind the principal.

Source

pub fn with<K, V>(self, key: K, value: V) -> Self
where K: Into<String>, V: Into<Value>,

Bind one metadata field.

Source

pub fn enter(self) -> ScopeGuard

Activate this scope until the returned guard is dropped.

The enclosing scope, if any, becomes this one’s parent, so its fields are still visible unless shadowed.

Source

pub fn current() -> Option<Arc<ScopeFields>>

The active scope on this thread, if any.

Source

pub fn apply_current(event: &mut AuditEvent)

Apply the active scope’s fields to event, if there is one.

Source

pub fn current_correlation_id() -> Option<String>

The active correlation ID, for stamping an outgoing request.

Trait Implementations§

Source§

impl Debug for Scope

Source§

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

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

impl Default for Scope

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Forget for Scope

§

impl Freeze for Scope

§

impl Move for Scope

§

impl RefUnwindSafe for Scope

§

impl Send for Scope

§

impl Sync for Scope

§

impl Unpin for Scope

§

impl UnsafeUnpin for Scope

§

impl UnwindSafe for Scope

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more