distant_net::client

Struct ClientBuilder

pub struct ClientBuilder<H, C> { /* private fields */ }

Expand description

Builder for a Client or UntypedClient.

Implementations§

impl<H, C> ClientBuilder<H, C>

pub fn auth_handler<U>(self, auth_handler: U) -> ClientBuilder<U, C>

Configure the authentication handler to use when connecting to a server.

pub fn config(self, config: ClientConfig) -> Self

Configure the client-local configuration details.

pub fn connector<U>(self, connector: U) -> ClientBuilder<H, U>

Configure the connector to use to facilitate connecting to a server.

pub fn connect_timeout( self, connect_timeout: impl Into<Option<Duration>>, ) -> Self

Configure a maximum duration to wait for a connection to a server to complete.

pub fn version(self, version: Version) -> Self

Configure the version of the client.

impl ClientBuilder<(), ()>

pub fn new() -> Self

impl<H, C> ClientBuilder<H, C>
where H: AuthHandler + Send, C: Connector,

pub async fn connect_untyped(self) -> Result<UntypedClient>

Establishes a connection with a remote server using the configured Transport and other settings, returning a new UntypedClient instance once the connection is fully established and authenticated.

pub async fn connect<T, U>(self) -> Result<Client<T, U>>

Establishes a connection with a remote server using the configured Transport and other settings, returning a new Client instance once the connection is fully established and authenticated.

Trait Implementations§

impl Default for ClientBuilder<(), ()>

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<H, C> Freeze for ClientBuilder<H, C>
where H: Freeze, C: Freeze,

impl<H, C> RefUnwindSafe for ClientBuilder<H, C>
where H: RefUnwindSafe, C: RefUnwindSafe,

impl<H, C> Send for ClientBuilder<H, C>
where H: Send, C: Send,

impl<H, C> Sync for ClientBuilder<H, C>
where H: Sync, C: Sync,

impl<H, C> Unpin for ClientBuilder<H, C>
where H: Unpin, C: Unpin,

impl<H, C> UnwindSafe for ClientBuilder<H, C>
where H: UnwindSafe, C: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsAny for T
where T: 'static,

fn as_any(&self) -> &(dyn Any + 'static)

Converts reference to Any

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Converts mutable reference to Any

fn into_any(self: Box<T>) -> Box<dyn Any>

Consumes and produces Box<dyn Any>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V