Struct ModelingLabel 

#[non_exhaustive]
pub struct ModelingLabel {
    pub name: Option<String>,
    pub subscripts: Vec<i64>,
    pub parameters: BTreeMap<String, String>,
    pub description: Option<String>,
}

Human-authored modeling notation for one table or collection row.

This label preserves the mathematical model notation before the model was lowered into OMMX. For example, a variable written as x\[i, j\] can be represented as name = "x" and subscripts = \[i, j\].

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.

name: Option<String>

subscripts: Vec<i64>

parameters: BTreeMap<String, String>

description: Option<String>

Implementations

impl ModelingLabel

pub fn name(&self) -> &str

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

pub fn description(&self) -> &str

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

Trait Implementations

impl Clone for ModelingLabel

fn clone(&self) -> ModelingLabel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelingLabel

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

Formats the value using the given formatter.

impl Default for ModelingLabel

fn default() -> Self

Returns the “default value” for a type.

impl From<ModelingLabel> for ModelingLabel

fn from(label: ModelingLabel) -> Self

Converts to this type from the input type.

impl From<ModelingLabel> for ModelingLabel

fn from(label: ModelingLabel) -> Self

Converts to this type from the input type.

impl Message for ModelingLabel

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_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated 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 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<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 ModelingLabel

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModelingLabel