Struct holochain_tracing::Span

pub struct Span(pub RjSpan);

A wrapper around a simple rustracing_jaeger::RjSpan, providing some convenience functions. It overshadows the lower-level child and follower methods with simpler versions. To access the lower-level methods, use .0.

Methods

impl HSpan

pub fn map<__SHRINKWRAP_T, __SHRINKWRAP_F: FnMut(RjSpan) -> __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(&RjSpan) -> __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 RjSpan) -> __SHRINKWRAP_T, 

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

impl HSpan

pub fn event<S: Into<Cow<'static, str>>>(&mut self, msg: S)

pub fn error<S: Into<Cow<'static, str>>>(&mut self, kind: S, msg: S)

pub fn context(&self) -> Option<HSpanContext>

pub fn child_<'a, N: Into<Cow<'static, str>>, F>(
    &'a self,
    operation_name: N,
    f: F
) -> RjSpan where
    F: FnOnce(StartSpanOptions<AllSampler, SpanContextState>) -> RjSpan, 

Renaming of underlying child method

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

Renaming of underlying follow method

pub fn child<S: Into<Cow<'static, str>>>(&self, operation_name: S) -> Self

Call underlying child method with only a simple operation name

pub fn follower<S: Into<Cow<'static, str>>>(&self, operation_name: S) -> Self

Call underlying follower method with only a simple operation name

pub fn wrap<T>(self, data: T) -> SpanWrap<T>

Wrap this span in a SpanWrap along with some user data

pub fn noop() -> Self

e.g. for times when a function requires a RjSpan but we don't desire to actually instrument that function call.

pub fn todo(reason: &'static str) -> Self

Useful for retrofitting existing codebases with traces. This is a noop, but signals intent to eventually hook this up in a meaningful way, perhaps requiring some restructuring of the underlying code to make hookup possible.

pub fn fixme() -> Self

Like todo(), but lazier. There is no reason why this span can't be hooked up other than lack of programmer time. This signals that it'll be simple to hook up whenever you get around it.

Trait Implementations

impl AsMut<Span<SpanContextState>> for HSpan

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

Performs the conversion.

impl AsRef<Span<SpanContextState>> for HSpan

fn as_ref(&self) -> &RjSpan

Performs the conversion.

impl From<Span<SpanContextState>> for HSpan

fn from(span: RjSpan) -> HSpan

Performs the conversion.

impl Deref for HSpan

type Target = RjSpan

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for HSpan

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

Mutably dereferences the value.

impl Debug for HSpan

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

Formats the value using the given formatter.

impl Borrow<Span<SpanContextState>> for HSpan

fn borrow(&self) -> &RjSpan

Immutably borrows from an owned value.

impl BorrowMut<Span<SpanContextState>> for HSpan

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

Mutably borrows from an owned value.