Struct EnumStateRecorder

Source

pub struct EnumStateRecorder<T: RecordableEnum> { /* private fields */ }

Expand description

Records time series data for an enum-valued state. This is best-suited for categorical observations, where the name of the state and not a numeric value will be most relevant for diagnostic and forensic purposes.

Implementations§

Source §

impl<T: RecordableEnum + 'static> EnumStateRecorder<T>

Source

pub fn new( name: String, trace_category: &'static CStr, options: RecorderOptions, ) -> Result<Self, StateRecorderError>

Creates a new EnumStateRecorder with a given name.

See RecorderOptions for more details on options that can be specified.

Errors:

StateRecorderError::DuplicateName: metadata.name is already in use by a StateRecorder associated with manager.
StateRecorderError::IncompatibleString: Either name or the display name of a state cannot be converted to a CString.
StateRecorderError::InvalidOptions: options is invalid for the given mode.

Source

pub fn record(&mut self, state_enum: T)

Trait Implementations§

Source §

impl<T: RecordableEnum> Debug for EnumStateRecorder<T>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !UnwindSafe for EnumStateRecorder<T>

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

§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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

§