Struct Connect

pub struct Connect<C: Connection, Response> { /* private fields */ }

The future returned when creating a new SurrealDB instance

Implementations

impl<C, R> Connect<C, R>

where C: Connection,

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

Sets the maximum capacity of the connection

This is used to set bounds of the channels used internally as well set the capacity of the HashMap used for routing responses in case of the WebSocket client.

Setting this capacity to 0 (the default) means that unbounded channels will be used. If your queries per second are so high that the client is running out of memory, it might be helpful to set this to a number that works best for you.

Examples

use surrealdb::engine::remote::ws::Ws;
use surrealdb::Surreal;

let db = Surreal::new::<Ws>("localhost:8000")
    .with_capacity(100_000)
    .await?;

Trait Implementations

impl<C: Debug + Connection, Response: Debug> Debug for Connect<C, Response>

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

Formats the value using the given formatter.

impl<Client> IntoFuture for Connect<Client, ()>

where Client: Connection,

type Output = Result<(), Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <Connect<Client, ()> as IntoFuture>::Output> + Send + Sync>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl<Client> IntoFuture for Connect<Client, Surreal<Client>>

where Client: Connection,

type Output = Result<Surreal<Client>, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <Connect<Client, Surreal<Client>> as IntoFuture>::Output> + Send + Sync>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.