Struct Credentials

pub struct Credentials { /* private fields */ }

Credentials for the remote.it API. Remote.it credentials consist of an access key ID and a base64 encoded secret access key.

Example

You can directly create a new Credentials struct using the builder pattern:

let credentials = Credentials::builder()
    .r3_access_key_id("foo".to_owned())
    .r3_secret_access_key("YmFy".to_owned())
    .build();

If you enable the credentials_loader feature, you can also load the credentials from the default, or a custom file:

let creds_from_default_loc = Credentials::load_from_disk().call().unwrap();
let creds_from_custom_loc = Credentials::load_from_disk().custom_credentials_path(PathBuf::from(".env.remoteit")).call().unwrap();

Implementations

impl Credentials

pub fn key(&self) -> &[u8]

Returns

The base64 decoded secret access key.

pub fn access_key_id(&self) -> &str

Returns

A reference to the r3_access_key_id

pub fn secret_access_key(&self) -> &str

Returns

The base64 encoded r3_secret_access_key

pub fn builder() -> CredentialsBuilder

Validated the given secret access key and creates a new Credentials struct.

Errors

• base64::DecodeError if the secret access key is not base64 encoded.

Example

let credentials = Credentials::builder()
    .r3_access_key_id("foo".to_owned())
    .r3_secret_access_key("YmFy".to_owned())
    .build();

impl Credentials

Impl block for credentials_loader related functions.

pub fn load_from_disk() -> CredentialsLoadFromDiskBuilder

Attempts to load the remote.it credentials from the user’s home directory. The default location is ~/.remoteit/credentials.

Errors

• CredentialsLoaderError::HomeDirNotFound, when the dirs create cannot find the user’s home directory.
• CredentialsLoaderError::CouldNotReadCredentials, when the credentials file could not be parsed by the config crate.

Example

You can load credentials from the default path (~/.remoteit/credentials on Unix-like), or provide a custom path.

let credentials_file = Credentials::load_from_disk()
    .custom_credentials_path(PathBuf::from("path/to/file")) // Optional
    .call();

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credentials

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Credentials

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Credentials

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

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

const 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 Serialize for Credentials

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Credentials

impl StructuralPartialEq for Credentials