Struct HttpClient 

pub struct HttpClient { /* private fields */ }

Available on crate feature network-client only.

Client that can synchronize with a server over HTTP(S).

Implementations

impl HttpClient

pub fn new( account_id: AccountId, origin: Origin, device_signer: BoxedEd25519Signer, connection_id: String, ) -> Result<Self, Error>

Create a new client.

pub fn device_signer(&self) -> &BoxedEd25519Signer

Device signing key.

pub fn listen<F>( &self, options: ListenOptions, handler: impl Fn(NetworkChangeEvent) -> F + Send + Sync + 'static, ) -> WebSocketHandle

where F: Future<Output = ()> + Send + 'static,

Available on crate feature listen only.

Spawn a thread that listens for changes from the remote server using a websocket that performs automatic re-connection.

pub async fn num_connections(server: &Url) -> Result<usize, Error>

Total number of websocket connections on remote.

Trait Implementations

impl Clone for HttpClient

fn clone(&self) -> HttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpClient

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

Formats the value using the given formatter.

impl FileSyncClient for HttpClient

type Error = Error

Available on (crate features files or listen or network-client) and crate feature files only.

Error type for file sync client.

fn upload_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, file_info: &'life1 ExternalFile, path: &'life2 Path, progress: ProgressChannel, cancel: Receiver<CancelReason>, ) -> Pin<Box<dyn Future<Output = Result<StatusCode, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Available on (crate features files or listen or network-client) and crate feature files only.

Send a file.

fn download_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, file_info: &'life1 ExternalFile, path: &'life2 Path, progress: ProgressChannel, cancel: Receiver<CancelReason>, ) -> Pin<Box<dyn Future<Output = Result<StatusCode, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Available on (crate features files or listen or network-client) and crate feature files only.

Receive a file.

fn delete_file<'life0, 'life1, 'async_trait>( &'life0 self, file_info: &'life1 ExternalFile, ) -> Pin<Box<dyn Future<Output = Result<StatusCode, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on (crate features files or listen or network-client) and crate feature files only.

Delete a file on the remote server.

fn move_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 ExternalFile, to: &'life2 ExternalFile, ) -> Pin<Box<dyn Future<Output = Result<StatusCode, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Available on (crate features files or listen or network-client) and crate feature files only.

Move a file on the remote server.

fn compare_files<'life0, 'async_trait>( &'life0 self, local_files: FileSet, ) -> Pin<Box<dyn Future<Output = Result<FileTransfersSet, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Available on (crate features files or listen or network-client) and crate feature files only.

Compare local files with a remote server.

impl PartialEq for HttpClient

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SyncClient for HttpClient

type Error = Error

Error type for sync client.

fn origin(&self) -> &Origin

Origin of the remote server.

fn account_exists<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check if an account already exists.

fn create_account<'life0, 'async_trait>( &'life0 self, account: CreateSet, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a new account.

fn update_account<'life0, 'async_trait>( &'life0 self, account: UpdateSet, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update an account.

fn fetch_account<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CreateSet, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch an account from a remote server.

fn delete_account<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete the account on the server.

fn sync_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SyncStatus, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sync status on the server.

fn sync<'life0, 'async_trait>( &'life0 self, packet: SyncPacket, ) -> Pin<Box<dyn Future<Output = Result<SyncPacket, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sync with a remote.

fn scan<'life0, 'async_trait>( &'life0 self, request: ScanRequest, ) -> Pin<Box<dyn Future<Output = Result<ScanResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Scan commits in an event log.

fn diff<'life0, 'async_trait>( &'life0 self, request: DiffRequest, ) -> Pin<Box<dyn Future<Output = Result<DiffResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch a collection of event records since a given commit hash.

fn patch<'life0, 'async_trait>( &'life0 self, request: PatchRequest, ) -> Pin<Box<dyn Future<Output = Result<PatchResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Patch an event log.

impl Eq for HttpClient