pub struct Client { /* private fields */ }Expand description
A reusable native client. The caller owns the worker thread and event storage.
Implementations§
Source§impl Client
impl Client
Sourcepub fn new(config: ClientConfig, identity: ClientIdentity) -> Result<Self>
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.
Sourcepub fn with_assets(self, assets: Assets) -> Result<Self>
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.
Sourcepub fn run(
&self,
cancel: &CancellationToken,
options: RunOptions,
handler: impl FnMut(ClientEvent) -> Result<()>,
) -> Result<()>
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.
Sourcepub fn run_with_commands(
&self,
cancel: &CancellationToken,
options: RunOptions,
commands: &Receiver<ClientCommand>,
handler: impl FnMut(ClientEvent) -> Result<()>,
) -> Result<()>
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.