Struct PathComponent 

pub struct PathComponent {
    pub is_repeated: Option<bool>,
    pub register_to_match: Option<u32>,
    pub store_foreach_index_into_register: Option<u32>,
    pub field: Option<Field>,
}

A path component is either: (1) a field id to descend into (common case); (2) an array index (for repeated fields); (3) a map lookup operation (for repeated fields, where we snoop a sub-field as a map key)

Fields

is_repeated: Option<bool>

Only valid when using field_id. This makes select have foreach semantics. This means that the body of nested_instructions is executed several times, once per each repeated submessage.

register_to_match: Option<u32>

Only valid when using map_key_field_id. This defines which register (R1..R32) should be used to match the key of the dict in a map lookup operation. In other words: foreach msg in repeated message { if msg[map_key_field_id] == R[register_to_match] { break; // Lookup succeeded, PathComponent resolves here. } }

store_foreach_index_into_register: Option<u32>

Only valid when using field_id and is_repeated=true. When iterating over repeated fields, stores the current iteration index into the the register R1..R32 defined below. This can be used to do complex operations like “find the entry in the array that has width==100, remember its offset in the SRC array and overwrite the matching i-th element in the DST array. We will probably never implement this but it’s here for completeness.

field: Option<Field>

Implementations

impl PathComponent

pub fn is_repeated(&self) -> bool

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

pub fn register_to_match(&self) -> u32

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

pub fn store_foreach_index_into_register(&self) -> u32

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

Trait Implementations

impl Clone for PathComponent

fn clone(&self) -> PathComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathComponent

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

Formats the value using the given formatter.

impl Default for PathComponent

fn default() -> Self

Returns the “default value” for a type.

impl Message for PathComponent

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 PathComponent

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