Struct Comment 

pub struct Comment {
    pub instruction_index: Option<i32>,
    pub instruction_operand_index: Option<i32>,
    pub operand_expression_index: Option<i32>,
    pub string_table_index: Option<i32>,
    pub repeatable: Option<bool>,
    pub type: Option<i32>,
}

Fields

instruction_index: Option<i32>

Index into the global instruction table. This is here to enable comment processing without having to iterate over all instructions. There is an N:M mapping of instructions to comments.

instruction_operand_index: Option<i32>

Index into the operand array local to an instruction.

operand_expression_index: Option<i32>

Index into the expression array local to an operand, like in Reference. This is not currently used, but allows to implement expression substitutions.

string_table_index: Option<i32>

Index into the global string table.

repeatable: Option<bool>

Comment is propagated to all locations that reference the original location.

type: Option<i32>

Implementations

impl Comment

pub fn instruction_index(&self) -> i32

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

pub fn instruction_operand_index(&self) -> i32

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

pub fn operand_expression_index(&self) -> i32

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

pub fn string_table_index(&self) -> i32

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

pub fn repeatable(&self) -> bool

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

pub fn type(&self) -> Type

Returns the enum value of type, or the default if the field is unset or set to an invalid enum value.

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl Default for Comment

fn default() -> Self

Returns the “default value” for a type.

impl Message for Comment

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 Comment

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

impl StructuralPartialEq for Comment