Crate remoteit_api

source ·
Expand description

§Remote.it API Wrapper

The most important structs are R3Client and Credentials.

To use this crate obtain your Credentials by loading them from disk using the provided methods, or, if you want to store the credentials in another way, instantiate a Credentials struct directly. See Credentials::load_from_disk and Credentials::builder for details and examples.

Then instantiate an R3Client using R3Client::builder and start calling the API functions on it.

§Features

  • Enable blocking to use the blocking versions of the API functions from the api_blocking module.
  • Enable async to use the asynchronous versions of the API funcitons from the api_async module.
  • Enable credentials_loader to use the Credentials::load_from_disk function. This is gated behind a feature, because it introduces additional dependencies.

Modules§

  • api_async
    Enabled by the async feature. Contains blocking implementations of the pre-written queries.
  • api_blocking
    Enabled by the blocking feature. Contains blocking implementations of the pre-written queries.
  • auth
    Contains functions related to request signing for the remote.it API. They are used by this lib, but you can also use them to implement your own abstraction.
  • credentials
    This module is related to loading remote.it credentials from the user’s home directory. This is of course not the most secure way to store credentials, but it is the most convenient and recommended by remote.it. If you store your credentials in a different way, you can pass them to the functions in this module directly instead of using this module to load them.
  • credentials_loader
    Contains items related to loading credentials from disk.
  • operations

Structs§

Constants§