Struct Span 

pub struct Span<T>(/* private fields */);

Span.

When this span is dropped, it will be converted to FinishedSpan and it will be sent to the associated SpanReceiver.

Implementations

impl<T> Span<T>

pub const fn inactive() -> Self

Makes an inactive span.

This span is never traced.

Examples

use cf_rustracing::span::Span;

let span = Span::<()>::inactive();
assert!(! span.is_sampled());

pub fn handle(&self) -> SpanHandle<T>

where T: Clone,

Returns a handle of this span.

pub fn is_sampled(&self) -> bool

Returns true if this span is sampled (i.e., being traced).

pub fn context(&self) -> Option<&SpanContext<T>>

Returns the context of this span.

pub fn set_operation_name<F, N>(&mut self, f: F)

where F: FnOnce() -> N, N: Into<Cow<'static, str>>,

Sets the operation name of this span.

pub fn set_start_time<F>(&mut self, f: F)

where F: FnOnce() -> SystemTime,

Sets the start time of this span.

pub fn set_finish_time<F>(&mut self, f: F)

where F: FnOnce() -> SystemTime,

Sets the finish time of this span.

pub fn set_finish_callback<C>(&mut self, cb: C)

where C: Into<FinishSpanCallback<T>>,

Sets the finish callback for this span.

pub fn take_finish_callback(&mut self) -> Option<FinishSpanCallback<T>>

Extracts any inherited or explicitly added finish callback from this span.

This can be used either to unset the callback, by discarding the returned value, or to wrap it in a new callback.

pub fn set_tag<F>(&mut self, f: F)

where F: FnOnce() -> Tag,

Sets the tag to this span.

pub fn set_tags<F, I>(&mut self, f: F)

where F: FnOnce() -> I, I: IntoIterator<Item = Tag>,

Sets the tags to this span.

pub fn set_baggage_item<F>(&mut self, f: F)

where F: FnOnce() -> BaggageItem,

Sets the baggage item to this span.

pub fn get_baggage_item(&self, name: &str) -> Option<&BaggageItem>

Gets the baggage item that has the name name.

pub fn log<F>(&mut self, f: F)

where F: FnOnce(&mut LogBuilder),

Logs structured data.

pub fn error_log<F>(&mut self, f: F)

where F: FnOnce(&mut StdErrorLogFieldsBuilder<'_>),

Logs an error.

This is a simple wrapper of log method except that the StdTag::error() tag will be set in this method.

pub fn child<N, F>(&self, operation_name: N, f: F) -> Span<T>

where N: Into<Cow<'static, str>>, T: Clone, F: FnOnce(StartSpanOptions<'_, AllSampler, T>) -> Span<T>,

Starts a ChildOf span if this span is sampled.

The child will inherit this span’s finish callback, if it has one. To avoid this kind of inheritance, you can use span.handle().child(...) instead.

pub fn follower<N, F>(&self, operation_name: N, f: F) -> Span<T>

where N: Into<Cow<'static, str>>, T: Clone, F: FnOnce(StartSpanOptions<'_, AllSampler, T>) -> Span<T>,

Starts a FollowsFrom span if this span is sampled.

Trait Implementations

impl<T: Debug> Debug for Span<T>

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

Formats the value using the given formatter.

impl<T> Drop for Span<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> InspectableSpan<T> for Span<T>

fn operation_name(&self) -> &str

Returns the operation name of this span.

fn start_time(&self) -> SystemTime

Returns the start time of this span.

fn finish_time(&self) -> Option<SystemTime>

Returns the finish time of this span.

fn logs(&self) -> &[Log]

Returns the logs recorded during this span.

fn tags(&self) -> &[Tag]

Returns the tags of this span.

fn references(&self) -> &[SpanReference<T>]

Returns the references of this span.

impl<T> MaybeAsRef<SpanContext<T>> for Span<T>

fn maybe_as_ref(&self) -> Option<&SpanContext<T>>

Performs the conversion.