Struct FieldPathElement

pub struct FieldPathElement {
    pub field_number: Option<i32>,
    pub field_name: Option<String>,
    pub field_type: Option<i32>,
    pub key_type: Option<i32>,
    pub value_type: Option<i32>,
    pub subscript: Option<Subscript>,
}

FieldPathElement provides enough information to nest through a single protobuf field.

If the selected field is a map or repeated field, the subscript value selects a specific element from it. A path that refers to a value nested under a map key or repeated field index will have a subscript value. The field_type field allows unambiguous resolution of a field even if descriptors are not available.

Fields

field_number: Option<i32>

field_number is the field number this path element refers to.

field_name: Option<String>

field_name contains the field name this path element refers to. This can be used to display a human-readable path even if the field number is unknown.

field_type: Option<i32>

field_type specifies the type of this field. When using reflection, this value is not needed.

This value is provided to make it possible to traverse unknown fields through wire data. When traversing wire data, be mindful of both packed[1] and delimited[2] encoding schemes.

[1]: https://protobuf.dev/programming-guides/encoding/#packed [2]: https://protobuf.dev/programming-guides/encoding/#groups

N.B.: Although groups are deprecated, the corresponding delimited encoding scheme is not, and can be explicitly used in Protocol Buffers 2023 Edition.

key_type: Option<i32>

key_type specifies the map key type of this field. This value is useful when traversing unknown fields through wire data: specifically, it allows handling the differences between different integer encodings.

value_type: Option<i32>

value_type specifies map value type of this field. This is useful if you want to display a value inside unknown fields through wire data.

subscript: Option<Subscript>

subscript contains a repeated index or map key, if this path element nests into a repeated or map field.

Implementations

impl FieldPathElement

pub fn field_number(&self) -> i32

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

pub fn field_name(&self) -> &str

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

pub fn field_type(&self) -> Type

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

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

Sets field_type to the provided enum value.

pub fn key_type(&self) -> Type

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

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

Sets key_type to the provided enum value.

pub fn value_type(&self) -> Type

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

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

Sets value_type to the provided enum value.

Trait Implementations

impl Clone for FieldPathElement

fn clone(&self) -> FieldPathElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldPathElement

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

Formats the value using the given formatter.

impl Default for FieldPathElement

fn default() -> Self

Returns the “default value” for a type.

impl Message for FieldPathElement

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 FieldPathElement

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