Skip to main content

ClientOptions

Struct ClientOptions 

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

Connection settings for ArcadeDbClient::connect_with.

Defaults: plaintext transport, 30 connect attempts with a 400ms backoff, no per-request deadline.

Implementations§

Source§

impl ClientOptions

Source

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

Settings for addr (host:port), credentials, and the default database — plaintext transport, default retry policy.

Source

pub fn open_or_create(self, yes: bool) -> Self

After connecting, create database if it does not exist (as a "graph" database). Tolerates the AlreadyExists race — two bootstrapping workers pointing at the same fresh database both succeed.

Source

pub fn tls(self, config: ClientTlsConfig) -> Self

Use a TLS transport with this config (e.g. ClientTlsConfig::new().ca_certificate(..)). Implies the https scheme; without it the channel is plaintext.

Source

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

Per-attempt TCP connect deadline (a cold JVM that accepts nothing fails the attempt fast instead of hanging).

Source

pub fn connect_attempts(self, attempts: u32) -> Self

How many times to retry the TCP connect before giving up (default 30).

Source

pub fn connect_backoff(self, backoff: Duration) -> Self

Delay between connect attempts (default 400ms).

Source

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

Default per-request gRPC deadline, applied to every call that does not set its own timeout. Prevents a hung server from stalling callers forever (and the Transaction drop-guard from silently rolling back a wedged transaction).

Source

pub fn from_env() -> Result<Self>

Read settings from the environment with the standard ARCADEDB_ prefix: ARCADEDB_ADDR, ARCADEDB_USER, ARCADEDB_PASSWORD, ARCADEDB_DATABASE. Missing/empty variables are a ArcadeDbError::InvalidInput naming the first offender.

Source

pub fn from_env_prefix(prefix: &str) -> Result<Self>

from_env with a custom prefix ({PREFIX}_ADDR, …).

Trait Implementations§

Source§

impl Clone for ClientOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientOptions

Source§

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

Formats the value using the given formatter. 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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