Struct TimeEvent

#[non_exhaustive]
pub struct TimeEvent {
    pub time: Option<Timestamp>,
    pub value: Option<Value>,
}

A time-stamped annotation or message event in the Span.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

time: Option<Timestamp>

The timestamp indicating the time the event occurred.

value: Option<Value>

A TimeEvent can contain either an Annotation object or a MessageEvent object, but not both.

Implementations

impl TimeEvent

pub fn set_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of time.

pub fn set_value<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of value.

pub fn get_annotation(&self) -> Option<&Box<Annotation>>

The value of value if it holds a Annotation, None if the field is not set or holds a different branch.

pub fn get_message_event(&self) -> Option<&Box<MessageEvent>>

The value of value if it holds a MessageEvent, None if the field is not set or holds a different branch.

pub fn set_annotation<T: Into<Box<Annotation>>>(self, v: T) -> Self

Sets the value of value to hold a Annotation.

Note that all the setters affecting value are mutually exclusive.

pub fn set_message_event<T: Into<Box<MessageEvent>>>(self, v: T) -> Self

Sets the value of value to hold a MessageEvent.

Note that all the setters affecting value are mutually exclusive.

Trait Implementations

impl Clone for TimeEvent

fn clone(&self) -> TimeEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeEvent

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

Formats the value using the given formatter.

impl Default for TimeEvent

fn default() -> TimeEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeEvent

where TimeEvent: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for TimeEvent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TimeEvent

fn eq(&self, other: &TimeEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TimeEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimeEvent