Struct FieldPath

pub struct FieldPath {
    pub elements: Vec<FieldPathElement>,
}

FieldPath provides a path to a nested protobuf field.

This message provides enough information to render a dotted field path even without protobuf descriptors. It also provides enough information to resolve a nested field through unknown wire data.

Fields

elements: Vec<FieldPathElement>

elements contains each element of the path, starting from the root and recursing downward.

Implementations

impl FieldPath

pub fn last_field(&self) -> Option<&FieldPathElement>

Returns the last member in the elements list, if the list is not empty.

pub fn parent_field(&self) -> Option<&FieldPathElement>

Returns the second last member in the elements list, if the list is not empty.

pub fn has_fields(&self) -> bool

Checks if the elements list is empty or not.

pub fn last_field_name(&self) -> Option<&str>

Returns the name of the last member in the elements list, if there is one.

pub fn get_field(&self, name: &str) -> Option<&FieldPathElement>

Searches for a FieldPathElement by name in the elements list.

pub fn field_path(&self) -> Vec<String>

Returns a vector with the names from each element in the list.

pub fn field_path_str(&self) -> String

Returns all of the names from each path element, joined by a dot (e.g. person.friend.0.address.street_name)

Trait Implementations

impl Clone for FieldPath

fn clone(&self) -> FieldPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldPath

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

Formats the value using the given formatter.

impl Default for FieldPath

fn default() -> Self

Returns the “default value” for a type.

impl Message for FieldPath

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 FieldPath

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