Struct SessionState 

pub struct SessionState {
    pub namespace: Option<String>,
    pub database: Option<String>,
    pub token: Option<String>,
    pub scope: Option<String>,
    pub params: HashMap<String, Value>,
}

Session state management for SurrealDB connections

Fields

namespace: Option<String>

Current namespace

database: Option<String>

Current database

token: Option<String>

Authentication token

scope: Option<String>

Current scope (for record-level authentication)

params: HashMap<String, Value>

Session parameters set via let

Implementations

impl SessionState

pub fn new() -> Self

Create a new empty session state

pub fn set_namespace(&mut self, namespace: Option<String>)

Set the namespace

pub fn set_database(&mut self, database: Option<String>)

Set the database

pub fn set_token(&mut self, token: Option<String>)

Set the authentication token

pub fn set_scope(&mut self, scope: Option<String>)

Set the scope

pub fn set_param(&mut self, key: String, value: Value)

Set a session parameter

pub fn unset_param(&mut self, key: &str)

Remove a session parameter

pub fn get_param(&self, key: &str) -> Option<&Value>

Get a session parameter

pub fn clear_params(&mut self)

Clear all session parameters

pub fn is_authenticated(&self) -> bool

Check if authenticated (has a token)

pub fn get_target(&self) -> (Option<&String>, Option<&String>)

Get the current namespace/database pair as a tuple

pub fn set_target( &mut self, namespace: Option<String>, database: Option<String>, )

Set both namespace and database at once

pub fn clear_auth(&mut self)

Clear all authentication data

pub fn reset(&mut self)

Reset the entire session state

pub fn params(&self) -> &HashMap<String, Value>

Get all parameters as a reference

pub fn merge_params(&mut self, params: HashMap<String, Value>)

Merge parameters from another map

Trait Implementations

impl Clone for SessionState

fn clone(&self) -> SessionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionState

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

Formats the value using the given formatter.

impl Default for SessionState

fn default() -> SessionState

Returns the “default value” for a type.