Struct FieldMask 

pub struct FieldMask {
    pub paths: Vec<String>,
    /* private fields */
}

Fields

paths: Vec<String>

Field 1: paths

Implementations

impl FieldMask

pub fn from_paths(paths: impl IntoIterator<Item = impl Into<String>>) -> Self

Create a FieldMask from an iterator of field paths.

Example

use buffa_types::google::protobuf::FieldMask;

let mask = FieldMask::from_paths(["user.name", "user.email"]);
assert!(mask.contains("user.name"));

pub fn contains(&self, path: &str) -> bool

Returns true if path is present in this field mask.

Comparison is exact (case-sensitive, no wildcard expansion). Runs in O(n) time where n is the number of paths.

pub fn len(&self) -> usize

Returns the number of paths in the field mask.

pub fn is_empty(&self) -> bool

Returns true if the field mask contains no paths.

pub fn iter(&self) -> Iter<'_, String>

Returns an iterator over the paths in the field mask.

impl FieldMask

pub const TYPE_URL: &'static str = "type.googleapis.com/google.protobuf.FieldMask"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for FieldMask

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for FieldMask

fn clone(&self) -> FieldMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldMask

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

Formats the value using the given formatter.

impl Default for FieldMask

fn default() -> FieldMask

Returns the “default value” for a type.

impl DefaultInstance for FieldMask

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

impl<'de> Deserialize<'de> for FieldMask

Available on crate feature json only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserializes from a comma-separated string of lowerCamelCase field paths.

Errors

Returns an error if any path component contains an underscore, which is invalid in the lowerCamelCase JSON representation.

impl<'a> IntoIterator for &'a FieldMask

type Item = &'a String

The type of the elements being iterated over.

type IntoIter = Iter<'a, String>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for FieldMask

type Item = String

The type of the elements being iterated over.

type IntoIter = IntoIter<String>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Message for FieldMask

fn compute_size(&self) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer.

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, depth: u32, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn cached_size(&self) -> u32

The cached encoded size from the last compute_size() call.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Convenience: compute size, then write. This is the primary encoding API.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

fn encode_to_vec(&self) -> Vec<u8>

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

fn decode(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

fn decode_length_delimited(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, depth: u32, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, depth: u32, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

fn merge(&mut self, buf: &mut impl Buf, depth: u32) -> Result<(), DecodeError>

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

fn merge_length_delimited( &mut self, buf: &mut impl Buf, depth: u32, ) -> Result<(), DecodeError>

Merge fields from a length-delimited sub-message payload into this message.

impl PartialEq for FieldMask

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

Available on crate feature json only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serializes as a comma-separated string of lowerCamelCase field paths.

Errors

Returns an error if any path cannot round-trip through camelCase conversion (e.g. paths that are already camelCase, contain consecutive underscores, or have digits immediately after underscores).

impl StructuralPartialEq for FieldMask