Struct ReportUnitMetadata

pub struct ReportUnitMetadata {
    pub complete: Option<bool>,
    pub module_name: Option<String>,
    pub module_id: Option<u32>,
    pub source_path: Option<String>,
    pub progress_categories: Vec<String>,
    pub auto_generated: Option<bool>,
}

Extra metadata for a unit

Fields

complete: Option<bool>

Whether this unit is marked as complete (or “linked”)

module_name: Option<String>

The name of the module this unit belongs to

module_id: Option<u32>

The ID of the module this unit belongs to

source_path: Option<String>

The path to the source file of this unit

progress_categories: Vec<String>

Progress categories for this unit

auto_generated: Option<bool>

Whether this unit is automatically generated (not user-provided)

Implementations

impl ReportUnitMetadata

pub fn complete(&self) -> bool

Returns the value of complete, or the default value if complete is unset.

pub fn module_name(&self) -> &str

Returns the value of module_name, or the default value if module_name is unset.

pub fn module_id(&self) -> u32

Returns the value of module_id, or the default value if module_id is unset.

pub fn source_path(&self) -> &str

Returns the value of source_path, or the default value if source_path is unset.

pub fn auto_generated(&self) -> bool

Returns the value of auto_generated, or the default value if auto_generated is unset.

Trait Implementations

impl Clone for ReportUnitMetadata

fn clone(&self) -> ReportUnitMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReportUnitMetadata

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

Formats the value using the given formatter.

impl Default for ReportUnitMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReportUnitMetadata

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ReportUnitMetadata

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for ReportUnitMetadata

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

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 ReportUnitMetadata