pub struct SpanCollector { /* private fields */ }Expand description
Thread-local span collector. Accumulates completed spans and tracks the active span stack for automatic parent assignment.
Implementations§
Source§impl SpanCollector
impl SpanCollector
pub fn new() -> Self
Sourcepub fn start(&mut self, kind: SpanKind, name: String) -> u64
pub fn start(&mut self, kind: SpanKind, name: String) -> u64
Start a new span. Returns the span ID.
Sourcepub fn start_with_links(
&mut self,
kind: SpanKind,
name: String,
links: Vec<SpanLink>,
) -> u64
pub fn start_with_links( &mut self, kind: SpanKind, name: String, links: Vec<SpanLink>, ) -> u64
Start a new span with non-parent causal links. Returns the span ID.
Sourcepub fn start_detached_with_links(
&mut self,
kind: SpanKind,
name: String,
links: Vec<SpanLink>,
) -> u64
pub fn start_detached_with_links( &mut self, kind: SpanKind, name: String, links: Vec<SpanLink>, ) -> u64
Start a root span with non-parent causal links. Returns the span ID.
Sourcepub fn set_metadata(&mut self, span_id: u64, key: &str, value: Value)
pub fn set_metadata(&mut self, span_id: u64, key: &str, value: Value)
Attach metadata to an open span.
Sourcepub fn attach_metadata_if_absent(
&mut self,
span_id: u64,
key: &str,
value: Value,
)
pub fn attach_metadata_if_absent( &mut self, span_id: u64, key: &str, value: Value, )
Attach metadata to an open or completed span unless the key exists.
Sourcepub fn record_event(
&mut self,
span_id: u64,
name: String,
attributes: BTreeMap<String, Value>,
) -> bool
pub fn record_event( &mut self, span_id: u64, name: String, attributes: BTreeMap<String, Value>, ) -> bool
Append a sub-phase annotation to an open span. Returns true if
the event was attached; false if span_id does not match any
open span (already closed or never opened).
Sourcepub fn open_start_unix_ms(&self, span_id: u64) -> Option<u64>
pub fn open_start_unix_ms(&self, span_id: u64) -> Option<u64>
Read the wall-clock start of an open span.
Sourcepub fn end(&mut self, span_id: u64) -> Option<Span>
pub fn end(&mut self, span_id: u64) -> Option<Span>
End a span. Moves it from open to completed and returns the
finalized span so callers (e.g. std/timing) can read its
duration_ms directly without re-scanning take_spans().
Sourcepub fn current_span_id(&self) -> Option<u64>
pub fn current_span_id(&self) -> Option<u64>
Get the current active span ID (if any).
Sourcepub fn span_link(&self, span_id: u64) -> Option<SpanLink>
pub fn span_link(&self, span_id: u64) -> Option<SpanLink>
Build a serializable link for an open span.
Sourcepub fn current_span_link(&self) -> Option<SpanLink>
pub fn current_span_link(&self) -> Option<SpanLink>
Build a serializable link for the current active span.
Sourcepub fn take_spans(&mut self) -> Vec<Span>
pub fn take_spans(&mut self) -> Vec<Span>
Take all completed spans (drains the collector).
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SpanCollector
impl RefUnwindSafe for SpanCollector
impl Send for SpanCollector
impl Sync for SpanCollector
impl Unpin for SpanCollector
impl UnsafeUnpin for SpanCollector
impl UnwindSafe for SpanCollector
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);