State

trippy_core

Struct State 

Source 
pub struct State { /* private fields */ }
Expand description

The state of a trace.

Implementations§

Source§

impl State

Source

pub fn new(state_config: StateConfig) -> Self

Create a new State.

Source

pub const fn default_flow_id() -> FlowId

Return the id of the default flow.

Source

pub fn hops(&self) -> &[Hop]

Information about each hop for the combined default flow.

Source

pub fn hops_for_flow(&self, flow_id: FlowId) -> &[Hop]

Information about each hop for a given flow.

Source

pub fn is_target(&self, hop: &Hop, flow_id: FlowId) -> bool

Is a given Hop the target hop for a given flow?

A Hop is considered to be the target if it has the highest ttl value observed.

Note that if the target host does not respond to probes then the highest ttl observed will be one greater than the ttl of the last host which did respond.

Source

pub fn is_in_round(&self, hop: &Hop, flow_id: FlowId) -> bool

Is a given Hop in the current round for a given flow?

Source

pub fn target_hop(&self, flow_id: FlowId) -> &Hop

Return the target Hop for a given flow.

Source

pub fn round(&self, flow_id: FlowId) -> Option<usize>

The current round of tracing for a given flow.

Source

pub fn round_count(&self, flow_id: FlowId) -> usize

The total rounds of tracing for a given flow.

Source

pub const fn round_flow_id(&self) -> FlowId

The FlowId for the current round.

Source

pub fn flows(&self) -> &[(Flow, FlowId)]

The registry of flows in the trace.

Source

pub fn error(&self) -> Option<&str>

The error message for the trace, if any.

Source

pub fn set_error(&mut self, error: Option<String>)

Source

pub const fn max_samples(&self) -> usize

The maximum number of samples to record per hop.

Source

pub const fn max_flows(&self) -> usize

The maximum number of flows to record.

Source

pub fn update_from_round(&mut self, round: &Round<'_>)

Update the tracing state from a TracerRound.

Trait Implementations§

Source§

impl Clone for State

Source§

fn clone(&self) -> State

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for State

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for State

Source§

fn default() -> State

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for State

§

impl RefUnwindSafe for State

§

impl Send for State

§

impl Sync for State

§

impl Unpin for State

§

impl UnwindSafe for State

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more