Struct AsyncConnectionBuilder 

pub struct AsyncConnectionBuilder { /* private fields */ }

An async builder for creating database connections.

See ConnectionBuilder for the sync equivalent and the full contract. All setters are identical; only the terminal build() calls are async.

Example

use hyperdb_api::{AsyncConnectionBuilder, CreateMode, Result};

#[tokio::main]
async fn main() -> Result<()> {
    let conn = AsyncConnectionBuilder::new("localhost:7483")
        .database("example.hyper")
        .create_mode(CreateMode::CreateIfNotExists)
        .auth("myuser", "mypassword")
        .build()
        .await?;
    Ok(())
}

Implementations

impl AsyncConnectionBuilder

pub fn new(endpoint: impl Into<String>) -> Self

Creates a new builder for the given endpoint.

pub fn database(self, path: impl AsRef<Path>) -> Self

Sets the database path.

pub fn create_mode(self, mode: CreateMode) -> Self

Sets the database creation mode.

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

Sets the username for authentication.

pub fn password(self, password: impl Into<String>) -> Self

Sets the password for authentication.

pub fn login_timeout(self, timeout: Duration) -> Self

Sets the login timeout.

pub fn query_timeout(self, timeout: Duration) -> Self

Sets the query timeout.

pub fn application_name(self, name: impl Into<String>) -> Self

Sets the application name sent to the server.

pub fn auth(self, user: impl Into<String>, password: impl Into<String>) -> Self

Convenience method to set user and password at once.

pub fn create_new_database(self, database_path: impl AsRef<Path>) -> Self

Convenience method to create a new database.

pub fn create_or_open_database(self, database_path: impl AsRef<Path>) -> Self

Convenience method to create database if it doesn’t exist.

pub fn open_database(self, database_path: impl AsRef<Path>) -> Self

Convenience method to open an existing database.

pub fn transfer_mode(self, mode: TransferMode) -> Self

Sets the transfer mode for gRPC connections (ignored for TCP).

pub async fn build(self) -> Result<AsyncConnection>

Builds and establishes the connection (async).

Transport is auto-detected from the endpoint URL:

• https:// / http:// → gRPC
• tab.domain:// → Unix domain socket (Unix only)
• tab.pipe:// → named pipe (Windows only)
• otherwise → TCP

Errors

• Returns Error::Io or Error::Client if the transport handshake fails (TCP refused, TLS rejected, named-pipe not found, gRPC channel setup failure).
• Returns Error::Client if authentication is rejected.
• Returns Error::Client if the CreateMode SQL is rejected for a builder that configured a database path.

Trait Implementations

impl Clone for AsyncConnectionBuilder

fn clone(&self) -> AsyncConnectionBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncConnectionBuilder

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

Formats the value using the given formatter.

impl Default for AsyncConnectionBuilder

fn default() -> Self

Returns the “default value” for a type.