Struct remoteit_api::credentials::Credentials

pub struct Credentials { /* private fields */ }

Implementations

impl Credentials

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")
    .r3_secret_access_key("YmFy")
    .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

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

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a copy of the value.

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 Ord for Credentials

fn cmp(&self, other: &Credentials) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Credentials

fn eq(&self, other: &Credentials) -> 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 PartialOrd for Credentials

fn partial_cmp(&self, other: &Credentials) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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