Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

A Geode database client using QUIC transport.

Use the builder pattern to configure the client, then call connect to establish a connection.

§Example

use geode_client::Client;

let client = Client::new("127.0.0.1", 3141)
    .skip_verify(true)  // Development only!
    .page_size(500)
    .client_name("my-app");

let mut conn = client.connect().await?;
let (page, _) = conn.query("RETURN 1 AS x").await?;
conn.close()?;

Implementations§

Source§

impl Client

Source

pub fn new(host: impl Into<String>, port: u16) -> Self

Create a new QUIC client for the specified host and port.

§Arguments
  • host - The server hostname or IP address
  • port - The server port (typically 3141 for Geode)
§Example
use geode_client::Client;

let client = Client::new("localhost", 3141);
let client = Client::new("192.168.1.100", 8443);
let client = Client::new(String::from("geode.example.com"), 3141);
Source

pub fn from_dsn(dsn: &str) -> Result<Self>

Create a new client from a DSN (Data Source Name) string.

Supported formats:

  • host:port - Basic connection
  • host:port?options - With query parameters
  • geode://host:port?options - URL format
  • geode://user:pass@host:port?options - With authentication

Supported options:

  • page_size - Results page size (default: 1000)
  • hello_name - Client name (default: “geode-rust-quinn”)
  • hello_ver - Client version (default: “0.1.0”)
  • conformance - GQL conformance level (default: “min”)
  • insecure - Skip TLS verification (true/false, default: false)
§Example
use geode_client::Client;

// Simple DSN
let client = Client::from_dsn("localhost:3141").unwrap();

// With options
let client = Client::from_dsn("localhost:3141?insecure=true&page_size=500").unwrap();

// URL format with auth
let client = Client::from_dsn("geode://admin:secret@localhost:3141?insecure=true").unwrap();
Source

pub fn skip_verify(self, skip: bool) -> Self

Skip TLS certificate verification.

§Security Warning

This should only be used in development environments. Disabling certificate verification makes the connection vulnerable to man-in-the-middle attacks.

§Arguments
  • skip - If true, skip certificate verification
Source

pub fn page_size(self, size: usize) -> Self

Set the page size for query results.

Controls how many rows are returned per page when fetching results. Larger values reduce round-trips but use more memory.

§Arguments
  • size - Number of rows per page (default: 1000)
Source

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

Set the client name sent to the server.

This appears in server logs and can help with debugging.

§Arguments
  • name - Client application name (default: “geode-rust-quinn”)
Source

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

Set the client version sent to the server.

§Arguments
  • version - Client version string (default: “0.1.0”)
Source

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

Set the GQL conformance level.

§Arguments
  • level - Conformance level (default: “min”)
Source

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

Set the authentication username.

§Arguments
  • username - The username for authentication
§Example
use geode_client::Client;

let client = Client::new("localhost", 3141)
    .username("admin")
    .password("secret");
Source

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

Set the authentication password.

§Arguments
  • password - The password for authentication
Source

pub async fn connect(&self) -> Result<Connection>

Connect to the Geode database.

Establishes a QUIC connection to the server, performs the TLS handshake, and sends the initial HELLO message.

§Returns

A Connection that can be used to execute queries.

§Errors

Returns an error if:

  • The hostname cannot be resolved
  • The connection cannot be established
  • TLS verification fails (unless skip_verify is true)
  • The HELLO handshake fails
§Example
let client = Client::new("localhost", 3141).skip_verify(true);
let mut conn = client.connect().await?;
// Use connection...
conn.close()?;

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more