Enum MaskMode 

pub enum MaskMode {
    Omit,
    Stub,
}

Controls how hidden nodes are rendered when a NodeMask is used in GraphDb::node_info_masked, GraphDb::node_edges_masked, and GraphDb::neighborhood_masked.

The default is MaskMode::Omit, which preserves byte-identical behaviour with all pre-existing masked paths. MaskMode::Stub is an explicit opt-in that discloses node existence — suitable only for full-token client masks. Role-token paths are hard-coded to Omit.

Existence-disclosure warning: Stub mode intentionally tells the caller whether a node exists, even if its contents are hidden. Only use this on client-mask (full-token) paths where the caller already has that knowledge implicitly.

Variants

Omit

Hidden nodes are silently omitted from every result — behaviour is byte-identical to the pre-existing masked-query paths. This is the default.

Stub

Hidden nodes’ existence is acknowledged via a restricted stub: {"key": "<key>", "restricted": true}. No label, props, or other fields are included in the stub.

Trait Implementations

impl Clone for MaskMode

fn clone(&self) -> MaskMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaskMode

impl Debug for MaskMode

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

Formats the value using the given formatter.

impl Default for MaskMode

fn default() -> MaskMode

Returns the “default value” for a type.

impl Eq for MaskMode

impl PartialEq for MaskMode

fn eq(&self, other: &MaskMode) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MaskMode