Struct updatehub_sdk::Client

pub struct Client { /* private fields */ }

The Client allow for requests to be sent.

Implementations

impl Client

pub fn new(server_address: &str) -> Self

Constructs a new Client.

pub async fn info(&self) -> Result<Response>

Get the current state of the agent.

Example

let client = updatehub_sdk::Client::default();
let response = client.info().await?;

Errors

This method fails when cannot complete the request at the address or cannot parse the body json as a info::Response.

pub async fn probe(&self, custom: Option<String>) -> Result<Response>

Probe the agent for update.

Example

let client = updatehub_sdk::Client::default();
let response = client.probe(None).await?;

A custom address can be used:

let client = updatehub_sdk::Client::default();
let response = client.probe(Some("http://foo.bar".to_string())).await?;

Errors

This method fails when cannot complete the request at the address or cannot parse the body json as a probe::Response.

pub async fn local_install(&self, file: &Path) -> Result<Response>

Request agent to install a local update package passing a path as argument.

Example

let path = std::path::Path::new("/tmp/my-update-package.uhupkg");

let client = updatehub_sdk::Client::default();
let response = client.local_install(path).await?;

Errors

This method fails when cannot complete the request at the address or cannot parse the body json as a state::Response.

pub async fn remote_install(&self, url: &str) -> Result<Response>

Request agent to install a package from a URL.

Example

let client = updatehub_sdk::Client::default();
let response = client.remote_install("http://foo.bar").await?;

Errors

This method fails when cannot complete the request at the address or cannot parse the body json as a state::Response.

pub async fn abort_download(&self) -> Result<Response>

Tells agent to abort the current download.

Example

let client = updatehub_sdk::Client::default();
let response = client.abort_download().await?;

Errors

This method fails when cannot complete the request at the address or cannot parse the body json as a state::Response.

pub async fn log(&self) -> Result<Log>

Get the available log entries for the last update.

Example

let client = updatehub_sdk::Client::default();
let response = client.log().await?;

Errors

This method fails when cannot complete the request at the address or cannot parse the body json as a log::Log.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.