Struct TimeSeriesDataPoint

#[non_exhaustive]
pub struct TimeSeriesDataPoint {
    pub wall_time: Option<Timestamp>,
    pub step: i64,
    pub value: Option<Value>,
    /* private fields */
}

A TensorboardTimeSeries data point.

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.

wall_time: Option<Timestamp>

Wall clock timestamp when this data point is generated by the end user.

step: i64

Step index of this data point within the run.

value: Option<Value>

Value of this time series data point.

Implementations

impl TimeSeriesDataPoint

pub fn new() -> Self

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

Sets the value of wall_time.

pub fn set_step<T: Into<i64>>(self, v: T) -> Self

Sets the value of step.

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

Sets the value of value.

Note that all the setters affecting value are mutually exclusive.

pub fn scalar(&self) -> Option<&Box<Scalar>>

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

pub fn set_scalar<T: Into<Box<Scalar>>>(self, v: T) -> Self

Sets the value of value to hold a Scalar.

Note that all the setters affecting value are mutually exclusive.

pub fn tensor(&self) -> Option<&Box<TensorboardTensor>>

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

pub fn set_tensor<T: Into<Box<TensorboardTensor>>>(self, v: T) -> Self

Sets the value of value to hold a Tensor.

Note that all the setters affecting value are mutually exclusive.

pub fn blobs(&self) -> Option<&Box<TensorboardBlobSequence>>

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

pub fn set_blobs<T: Into<Box<TensorboardBlobSequence>>>(self, v: T) -> Self

Sets the value of value to hold a Blobs.

Note that all the setters affecting value are mutually exclusive.

Trait Implementations

impl Clone for TimeSeriesDataPoint

fn clone(&self) -> TimeSeriesDataPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeSeriesDataPoint

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

Formats the value using the given formatter.

impl Default for TimeSeriesDataPoint

fn default() -> TimeSeriesDataPoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeSeriesDataPoint

where TimeSeriesDataPoint: 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 TimeSeriesDataPoint

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TimeSeriesDataPoint

fn eq(&self, other: &TimeSeriesDataPoint) -> 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 TimeSeriesDataPoint

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 TimeSeriesDataPoint