Struct OriginSdk 

pub struct OriginSdk { /* private fields */ }

The client for interacting with the Origin SDK protocol.

Implementations

impl OriginSdk

pub async fn connect( config: ClientConfig, port: u16, ) -> Result<(Self, Receiver<Event>), SdkError>

Establish a connection to the Origin SDK server

Returns a tuple of:

• The OriginSdk client instance
• An mpsc::Receiver for incoming Events

pub async fn send_request<T>(&self, body: T) -> Result<T::Response, SdkError>

where T: RequestResponse + Into<RequestBody>,

Send a typed request to the server and await its response.

How requests & responses are defined

All request types are declared under crate::protocol and grouped by domain (achievements.rs, auth.rs, chat.rs, etc). Each request type implements RequestResponse, which is generated by the crate::request_response! macro.

This macro wires requests to their corresponding response body variants in ResponseBody. For example:

pub enum RequestBody {
    // ...
    GetProfile(GetProfile)
    // ...
}

pub enum ResponseBody {
    // ...
    GetProfileResponse(GetProfileResponse),
    // ...
}

request_response! {
    // ...
    GetProfile => GetProfileResponse,
    // ...
}

This means calling:

let profile: GetProfileResponse = client.send_request(GetProfile { /* ... */ }).await?;

automatically deserializes the server response into the correct type.

Trait Implementations

impl Drop for OriginSdk

fn drop(&mut self)

Executes the destructor for this type.