Struct FieldMaskTree 

pub struct FieldMaskTree { /* private fields */ }

Implementations

impl FieldMaskTree

pub fn new_wildcard() -> Self

pub fn add_field_path(&mut self, path: &str) -> &mut Self

pub fn from_field_mask(mask: &FieldMask) -> Self

pub fn to_field_mask(&self) -> FieldMask

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

Checks if the provided path is contained in this FieldMaskTree.

A path is considered a match and contained by this tree if it is a prefix for any contained paths, including if it is an exact match.

let mut tree = FieldMaskTree::default();
tree.add_field_path("foo.bar");

assert!(tree.contains("foo"));
assert!(tree.contains("foo.bar"));
assert!(!tree.contains("foo.baz"));

pub fn map_keys(&self) -> Option<impl Iterator<Item = &str>>

Returns the explicit map keys requested in this subtree, or None if this tree is a wildcard (no explicit key filter).

When a user specifies explicit map keys via a field mask (e.g. attributes.max_tx_gas), this method returns an iterator over those key names. When the tree is a wildcard, None is returned to indicate “no filter — return all (or none, per policy)”.

pub fn map_field_filter( &self, inner_field_name: &str, ) -> Option<Option<HashSet<String>>>

Determines which entries of an inner map field should be included.

Call this on the subtree rooted at a map-wrapper message field (e.g. the subtree at feature_flags or attributes inside ProtocolConfig) and pass the name of the inner map field (e.g. "flags" or "attributes"). The return value tells the caller what to put in the resulting map:

• None — the wrapper itself was a wildcard or the inner field was not explicitly requested → omit the wrapper field entirely (leave it as None in the response so clients can distinguish “not requested” from “empty”).
• Some(None) — the inner field was requested without specific keys (e.g. feature_flags.flags) → include all entries.
• Some(Some(keys)) — only these specific keys were requested (e.g. feature_flags.flags.flag_a) → include only those entries.

pub fn subtree<P: AsRef<str>>(&self, path: P) -> Option<Self>

Trait Implementations

impl Clone for FieldMaskTree

fn clone(&self) -> FieldMaskTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldMaskTree

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

Formats the value using the given formatter.

impl Default for FieldMaskTree

fn default() -> FieldMaskTree

Returns the “default value” for a type.

impl Display for FieldMaskTree

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

Formats the value using the given formatter.

impl From<FieldMask> for FieldMaskTree

fn from(mask: FieldMask) -> Self

Converts to this type from the input type.

impl From<FieldMaskTree> for FieldMask

fn from(tree: FieldMaskTree) -> Self

Converts to this type from the input type.

impl FromStr for FieldMaskTree

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.