Struct Hosts

pub struct Hosts(/* private fields */);

Mapped host configs by their hostname.

Implementations

impl Hosts

pub fn load() -> Result<Self, Error>

Loads all host configs from the default path.

pub fn load_from<P>(path: P) -> Result<Self, Error>

where P: AsRef<Path>,

Loads all host configs from the specified path.

pub fn get(&self, hostname: &str) -> Option<&Host>

Gets a host config by the hostname.

pub fn set(&mut self, hostname: impl Into<String>, host: Host) -> Option<Host>

Sets a host config and returns the current value. If no values present currently, returns None .

pub fn retrieve_token(&self, hostname: &str) -> Result<Option<String>, Error>

Retrieves a token from the environment variables, the hosts file, or the secure storage. User interaction may be required to unlock the keychain, depending on the OS. If any token found for the hostname, returns None.

pub fn retrieve_token_secure( &self, hostname: &str, ) -> Result<Option<String>, Error>

👎Deprecated since 0.4.0: Use retrieve_token_secure without Hosts struct instead.

Retrieves a token from the secure storage only. User interaction may be required to unlock the keychain, depending on the OS. If any token found for the hostname, returns None.

Trait Implementations

impl Clone for Hosts

fn clone(&self) -> Hosts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hosts

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hosts

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Hosts

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

where __S: Serializer,

Serialize this value into the given Serde serializer.