Struct SigninParams 

pub struct SigninParams {
    pub user: Option<String>,
    pub pass: Option<String>,
    pub namespace: Option<String>,
    pub database: Option<String>,
    pub scope: Option<String>,
    pub access: Option<String>,
    pub vars: HashMap<String, Value>,
}

Parameters for authentication

Fields

user: Option<String>

Username for root/namespace/database authentication

pass: Option<String>

Password for root/namespace/database authentication

namespace: Option<String>

Namespace for authentication

database: Option<String>

Database for authentication

scope: Option<String>

Scope for record-level authentication (legacy)

access: Option<String>

Access method for record-level authentication (v2.0+)

vars: HashMap<String, Value>

Additional authentication variables

Implementations

impl SigninParams

pub fn new() -> Self

Create new signin parameters

pub fn root(user: impl Into<String>, pass: impl Into<String>) -> Self

Create root user authentication

pub fn namespace( user: impl Into<String>, pass: impl Into<String>, namespace: impl Into<String>, ) -> Self

Create namespace user authentication

pub fn database( user: impl Into<String>, pass: impl Into<String>, namespace: impl Into<String>, database: impl Into<String>, ) -> Self

Create database user authentication

pub fn scope( namespace: impl Into<String>, database: impl Into<String>, scope: impl Into<String>, ) -> Self

Create scope-based authentication (legacy)

pub fn access( namespace: impl Into<String>, database: impl Into<String>, access: impl Into<String>, ) -> Self

Create access-based authentication (v2.0+)

pub fn with_var(self, key: impl Into<String>, value: Value) -> Self

Add an authentication variable

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

Convert to the format expected by SurrealDB RPC

Trait Implementations

impl Clone for SigninParams

fn clone(&self) -> SigninParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SigninParams

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

Formats the value using the given formatter.

impl Default for SigninParams

fn default() -> SigninParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SigninParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SigninParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.