Skip to main content

Client

Struct Client 

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

A reusable native client. The caller owns the worker thread and event storage.

Implementations§

Source§

impl Client

Source

pub fn new(config: ClientConfig, identity: ClientIdentity) -> Result<Self>

Validate settings and use the checksum inventory bundled with the crate.

§Errors

Returns an error when configuration, identity metadata, or the bundled asset inventory is invalid.

Source

pub fn with_assets(self, assets: Assets) -> Result<Self>

Replace the bundled checksum inventory with an application-supplied one.

§Errors

Returns an error when the supplied inventory lacks required spell data.

Source

pub fn run( &self, cancel: &CancellationToken, options: RunOptions, handler: impl FnMut(ClientEvent) -> Result<()>, ) -> Result<()>

Connect and deliver events synchronously until completion or cancellation. Run on a worker thread and keep the handler fast (typically enqueue events). A confirmed credential rejection returns LoginError without reconnecting. A handler error terminates the run, without reconnecting or invoking it again. Network waits and retry delays observe cancellation; system DNS resolution remains a blocking platform call. Sessions close when the run unwinds.

§Errors

Returns a LoginError for rejected credentials and otherwise returns transport, protocol, cancellation, or event-handler errors.

Source

pub fn run_with_commands( &self, cancel: &CancellationToken, options: RunOptions, commands: &Receiver<ClientCommand>, handler: impl FnMut(ClientEvent) -> Result<()>, ) -> Result<()>

Connect and process commands from a nonblocking host-owned queue. Commands are consumed only after zone admission and may remain queued while a reconnect is in progress. Dropping every sender disables input.

§Errors

Returns a LoginError for rejected credentials and otherwise returns transport, protocol, cancellation, command, or event-handler errors.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V