Struct CredentialProfiles

pub struct CredentialProfiles { /* private fields */ }

A struct representing the remote.it credentials file.

The credentials file can have multiple profiles, each with its own access key ID and secret access key.

The secret access keys of the profiles within this struct are base64 encoded. At this point they are unverified, which is why the inner HashMap is private. The secret key of the profile you want will be verified, when the profile is retrieved using one of:

• CredentialProfiles::take_profile
• [CredentialProfiles::profile]

Implementations

impl CredentialProfiles

pub fn take_profile( &mut self, profile_name: &str, ) -> Result<Option<Credentials>, DecodeError>

Takes the profile with the given name out of the inner HashMap, validated the secret access key and returns it. You can only take a profile once, after that it is removed from the inner HashMap.

Returns

• None if the profile with the given name does not exist.
• Some containing the Credentials with the given name, if the profile exists.

Errors

• base64::DecodeError if the secret access key of the profile with the given name is not base64 encoded.

pub fn len(&self) -> usize

Returns

The number of profiles in the inner HashMap.

pub fn is_empty(&self) -> bool

Returns

• true if there are no profiles in the inner HashMap.
• false if there is at least one profile in the inner HashMap.

pub fn available_profiles(&self) -> Vec<String>

Returns

A list of Strings containing the names of the profiles in the inner HashMap. The order of the profiles is not guaranteed.

Warning

This doesn’t mean that the profiles are valid (valid base64 encoded secret), only that they exist.

Trait Implementations

impl Clone for CredentialProfiles

fn clone(&self) -> CredentialProfiles

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialProfiles

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CredentialProfiles

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CredentialProfiles

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

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 CredentialProfiles

impl StructuralPartialEq for CredentialProfiles