Enum FieldMask

pub enum FieldMask {
    All,
    Prefix(FieldPath),
    Exact(FieldPath),
}

Represents a field mask, which is a projection of fields under a layout.

Variants

All

Select all fields in the layout

Prefix(FieldPath)

Select all with the FieldPath prefix

Exact(FieldPath)

Select a field matching exactly the FieldPath

Implementations

impl FieldMask

pub fn step_into(self) -> VortexResult<Self>

Creates a new field mask stepping one level into the layout structure.

pub fn starting_field(&self) -> VortexResult<Option<&Field>>

Returns the first field explicit select mask, if there is one, failing if mask = All.

pub fn matches_all(&self) -> bool

True iff all fields are selected (including self).

pub fn matches_root(&self) -> bool

True if the mask matches the root field.

Trait Implementations

impl Clone for FieldMask

fn clone(&self) -> FieldMask

Returns a copy 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 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 Eq for FieldMask

impl StructuralPartialEq for FieldMask