Struct SummaryMetadata

pub struct SummaryMetadata {
    pub plugin_data: Option<PluginData>,
    pub display_name: String,
    pub summary_description: String,
}

A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.

Fields

plugin_data: Option<PluginData>

Data that associates a summary with a certain plugin.

display_name: String

Display name for viewing in TensorBoard.

summary_description: String

Longform readable description of the summary sequence. Markdown supported.

Trait Implementations

impl Clone for SummaryMetadata

fn clone(&self) -> SummaryMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryMetadata

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

Formats the value using the given formatter.

impl Default for SummaryMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for SummaryMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SummaryMetadata

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