Struct DbClientConfig

pub struct DbClientConfig<'a> {
    pub address: Cow<'a, str>,
    pub namespace: Cow<'a, str>,
    pub database: Cow<'a, str>,
    pub auth_level: DbAuthLevel,
    pub username: Cow<'a, str>,
    pub password: Cow<'a, str>,
    pub capacity: usize,
}

Fields

address: Cow<'a, str>

Address of the database instance.

Examples:

• "ws://localhost:8000"
• "wss://cloud.surrealdb.com"

Default: "ws://localhost:8000"

namespace: Cow<'a, str>

Namespace to use on the database instance.

Default: "test"

database: Cow<'a, str>

Database to use inside the database instance.

Default: "test"

auth_level: DbAuthLevel

The kind of the system user used for authentication.

Default: Root

username: Cow<'a, str>

Username used to authenticate to the database instance.

Default: "root"

password: Cow<'a, str>

Password used to authenticate to the database instance.

Default: "root"

capacity: usize

Capacity of the channels to the database.

Example:

• 0 (= unbounded)
• 200

Default: 20

Implementations

impl<'a> DbClientConfig<'a>

pub fn with_address(self, address: impl Into<Cow<'a, str>>) -> Self

pub fn with_namespace(self, namespace: impl Into<Cow<'a, str>>) -> Self

pub fn with_database(self, database: impl Into<Cow<'a, str>>) -> Self

pub const fn with_auth_level(self, auth_level: DbAuthLevel) -> Self

pub fn with_username(self, username: impl Into<Cow<'a, str>>) -> Self

pub fn with_password(self, password: impl Into<Cow<'a, str>>) -> Self

pub const fn with_capacity(self, capacity: usize) -> Self

Trait Implementations

impl<'a> Clone for DbClientConfig<'a>

fn clone(&self) -> DbClientConfig<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DbClientConfig<'a>

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

Formats the value using the given formatter.

impl Default for DbClientConfig<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for DbClientConfig<'a>

fn eq(&self, other: &DbClientConfig<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for DbClientConfig<'a>

impl<'a> StructuralPartialEq for DbClientConfig<'a>