Struct NodeMask 

pub struct NodeMask { /* private fields */ }

Query-scoped node visibility filter (ACL primitive).

When a NodeMask is passed to query_masked, only nodes whose dense id appears in visible will be returned by label scans, key lookups, and neighbor expansions. Edges where either endpoint is hidden are silently dropped from the result.

Unknown keys in from_keys are silently ignored (they resolve to no id). An empty mask hides every node.

Implementations

impl NodeMask

pub fn from_keys<'a, F: Fs>( db: &GraphDb<F>, keys: impl IntoIterator<Item = &'a str>, ) -> Self

Resolve string keys to dense ids and build a mask.

Keys that do not exist in the database are ignored. The mask mode defaults to MaskMode::Omit; call NodeMask::with_mode to opt into MaskMode::Stub.

pub fn from_ids(ids: impl IntoIterator<Item = u32>) -> Self

Build a mask from an already-resolved iterator of dense node ids.

Used by ReaderSnapshot handlers that resolve keys against the frozen state without a GraphDb reference.

pub fn with_mode(self, mode: MaskMode) -> Self

Set the rendering mode, consuming self and returning a new mask.

SECURITY: never call with MaskMode::Stub on role-token paths.

pub fn mode(&self) -> MaskMode

Return the current rendering mode.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn intersect(&self, other: &NodeMask) -> NodeMask

Return a new mask that is the intersection of self and other.

The result contains only nodes visible in both masks. Used to enforce the never-widen rule when a role token also supplies a client mask: effective = role_mask.intersect(&client_mask).

The result always carries MaskMode::Omit — the role-path invariant means stubs must never slip through an intersection.

pub fn contains_id(&self, id: u32) -> bool

Return true if the dense node id is visible in this mask.

Used by ReaderSnapshot handlers where the key has already been resolved to a dense id (avoids a second lookup into a GraphDb).

pub fn contains_node<F: Fs>(&self, db: &GraphDb<F>, key: &str) -> bool

Return true if the node identified by key is visible in this mask.

Returns false for keys that do not exist in the database (unknown keys are never visible), as well as for keys that exist but are not in the visible set. Used by node-endpoint handlers to produce the same absent-key response for both missing and hidden nodes.

Trait Implementations

impl Clone for NodeMask

fn clone(&self) -> NodeMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeMask

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

Formats the value using the given formatter.