Struct xaynet_sdk::client::Client

pub struct Client<C> { /* fields omitted */ }

A client that communicates with the coordinator's API via HTTP(S).

Implementations

impl<C> Client<C> where
    C: XaynetHttpClient, 

pub fn new(http_client: C, base_url: &str) -> Result<Self, InvalidBaseUrl>

Create a new client.

Args

• client is the HTTP client that will be used to perform the HTTP requests. Any HTTP client can be used, as long as it implements the XaynetHttpClient trait.
• base_url is the URL to the Xaynet coordinator

Errors

An error is returned if base_url is not a valid URL

Trait Implementations

impl<C: Clone> Clone for Client<C>

pub fn clone(&self) -> Client<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Client<C>

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

Formats the value using the given formatter.

impl<C> XaynetClient for Client<C> where
    C: XaynetHttpClient + Send, 

type Error = ClientError

pub fn get_round_params<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<RoundParameters, Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieve the current round parameters

pub fn get_sums<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Option<SumDict>, Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieve the current sum dictionary, if available.

pub fn get_seeds<'life0, 'async_trait>(
    &'life0 mut self,
    pk: PublicSigningKey
) -> Pin<Box<dyn Future<Output = Result<Option<UpdateSeedDict>, Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieve the current seed dictionary for the given sum participant, if available.

pub fn get_model<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Option<Model>, Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieve the current global model, if available.

pub fn send_message<'life0, 'async_trait>(
    &'life0 mut self,
    msg: Vec<u8>
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Send an encrypted and signed PET message to the coordinator.