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 map<__SHRINKWRAP_T, __SHRINKWRAP_F: FnMut(T) -> __SHRINKWRAP_T>(
    self,
    f: __SHRINKWRAP_F
) -> __SHRINKWRAP_T

Map a function over the wrapped value, consuming it in the process.

pub fn map_ref<__SHRINKWRAP_T, __SHRINKWRAP_F: FnMut(&T) -> __SHRINKWRAP_T>(
    &self,
    f: __SHRINKWRAP_F
) -> __SHRINKWRAP_T

Map a function over the wrapped value without consuming it.

pub fn map_mut<__SHRINKWRAP_T, __SHRINKWRAP_F>(
    &mut self,
    f: __SHRINKWRAP_F
) -> __SHRINKWRAP_T where
    __SHRINKWRAP_F: FnMut(&mut T) -> __SHRINKWRAP_T, 

Map a function over the wrapped value, potentially changing it in place.

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_<'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, 

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> 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<T: Debug> Debug for SpanWrap<T>

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

Formats the value using the given formatter.

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.