Struct holochain_tracing::SpanWrap

pub struct SpanWrap<T> {
    pub data: T,
    pub span_context: Option<HSpanContext>,
}

SpanWrap is a simple way to couple some data along with a struct. It is common to send some data on a channel which will be used as arguments to a function on the receiving side, where we also want to continue the trace on the receiving side. This struct helps keep that data together with minimal boilerplate.

The use of shrinkwrap allows the entire struct to be used as if it were a bare T (in most situations), but the RjSpan can also be extracted.

Fields

data: T

span_context: Option<HSpanContext>

Methods

impl<T> SpanWrap<T>

pub fn new(data: T, span_context: Option<HSpanContext>) -> Self

pub fn follower<S: Into<Cow<'static, str>>>(
    &self,
    tracer: &Tracer,
    operation_name: S
) -> Option<HSpan>

pub fn follower_or_null<S: Into<Cow<'static, str>>>(
    &self,
    tracer: &Tracer,
    operation_name: S
) -> HSpan

pub fn follower_<'a, N: Into<Cow<'static, str>>, F>(
    &'a self,
    tracer: &Tracer,
    operation_name: N,
    f: F
) -> Option<HSpan> where
    F: FnOnce(StartSpanOptions<BoxSampler<SpanContextState>, SpanContextState>) -> RjSpan, 

pub fn map<F, U>(self, f: F) -> SpanWrap<U> where
    F: FnOnce(T) -> U, 

Map the data field to a new value while keeping the same span_context

Trait Implementations

impl<T> AsMut<T> for SpanWrap<T>

fn as_mut(&mut self) -> &mut T

Performs the conversion.

impl<T> AsRef<T> for SpanWrap<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T> Borrow<T> for SpanWrap<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for SpanWrap<T>

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<T: Debug> Debug for SpanWrap<T>

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

Formats the value using the given formatter.

impl<T> Deref for SpanWrap<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for SpanWrap<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T> From<EncodedSpanWrap<T>> for SpanWrap<T> where
    T: Serialize + DeserializeOwned + Clone, 

fn from(swe: EncodedSpanWrap<T>) -> Self

Performs the conversion.

impl<'a, T> From<SpanWrap<T>> for EncodedSpanWrap<T> where
    T: Serialize + DeserializeOwned + Clone, 

fn from(sw: SpanWrap<T>) -> Self

Performs the conversion.

impl<T: PartialEq> PartialEq<SpanWrap<T>> for SpanWrap<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.