Struct Identity 

pub struct Identity { /* private fields */ }

A verified identity bound to a session.

Created by the caller (typically a server or application layer) and passed to GrafeoDB::session_with_identity. The engine trusts the caller to construct the identity correctly.

Implementations

impl Identity

pub fn new( user_id: impl Into<String>, roles: impl IntoIterator<Item = Role>, ) -> Self

Creates a new identity with the given user ID and roles.

pub fn anonymous() -> Self

Creates an anonymous identity with full access.

Used internally when no identity is provided (backward-compatible default). Anonymous sessions have the Role::Admin role.

pub fn with_grants(self, grants: impl IntoIterator<Item = Grant>) -> Self

Adds per-graph access grants to this identity.

When grants are set, the identity can only access the listed graphs at the specified role level. Graphs not in the grant list are inaccessible regardless of the identity’s top-level roles.

pub fn user_id(&self) -> &str

Returns the user ID.

pub fn roles(&self) -> &HashSet<Role>

Returns the roles assigned to this identity.

pub fn has_role(&self, role: Role) -> bool

Returns true if this identity has the given role.

pub fn can_read(&self) -> bool

Returns true if this identity can perform read operations.

Any assigned role grants read access.

pub fn can_write(&self) -> bool

Returns true if this identity can perform write operations (create/update/delete nodes and edges, graph management).

pub fn can_admin(&self) -> bool

Returns true if this identity can perform admin operations (schema DDL, index management, GC, configuration changes).

pub fn grants(&self) -> &[Grant]

Returns the per-graph grants, if any.

pub fn has_grants(&self) -> bool

Returns true if this identity has per-graph restrictions.

pub fn can_access_graph(&self, graph: &str, required: Role) -> bool

Checks whether this identity can access the given graph at the required role level.

If no grants are configured, access is governed only by the identity’s top-level roles. If grants are configured, the graph must appear in the grant list with a sufficient role.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Identity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl Display for Identity

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

Formats the value using the given formatter.