Skip to main content

ContextScope

Struct ContextScope 

Source
pub struct ContextScope<'a> { /* private fields */ }
Expand description

Context scope for automatic span management

Implementations§

Source§

impl<'a> ContextScope<'a>

Source

pub fn new( store: &'a ContextStore, ctx: &Context, name: &str, node_id: NodeId, ) -> Self

Create a new scope that automatically records a span on drop

Source

pub fn with_kind(self, kind: SpanKind) -> Self

Set the kind of the underlying span

Source

pub fn set_attribute( &mut self, key: impl Into<String>, value: impl Into<AttributeValue>, )

Set an attribute on the underlying span

Source

pub fn add_event(&mut self, name: impl Into<String>)

Record a named event on the underlying span

Source

pub fn set_ok(&mut self)

Mark the underlying span as successfully completed

Source

pub fn set_error(&mut self, message: impl Into<String>)

Mark the underlying span as failed with the given message

Source

pub fn finish(self)

Explicitly finish the scope and submit the span to the store

Source

pub fn span(&self) -> &Span

Return a reference to the underlying span

Trait Implementations§

Source§

impl<'a> Drop for ContextScope<'a>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ContextScope<'a>

§

impl<'a> !UnwindSafe for ContextScope<'a>

§

impl<'a> Freeze for ContextScope<'a>

§

impl<'a> Send for ContextScope<'a>

§

impl<'a> Sync for ContextScope<'a>

§

impl<'a> Unpin for ContextScope<'a>

§

impl<'a> UnsafeUnpin for ContextScope<'a>

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