Struct credentials::Secretfile

pub struct Secretfile { /* fields omitted */ }

A basic interface for loading a Secretfile and listing the various variables and files contained inside.

Methods

impl Secretfile

pub fn read(read: &mut dyn Read) -> Result<Secretfile>

Read in from an io::Read object.

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Secretfile>

Load the Secretfile at the specified path.

pub fn set_built_in(secretfile: Option<Secretfile>)

Set a built-in Secretfile. This is intended for command-line applications called directly by users, which do not normally have a Secretfile in the current directory, and which probably want to ignore one if it exists.

This must be called before credentials::var.

pub fn default() -> Result<Secretfile>

Load the default Secretfile. This is normally Secretfile in the current working directory, but it can be overridden using Secretfile::set_built_in.

Important traits for SecretfileKeys<'a>

impl<'a> Iterator for SecretfileKeys<'a> type Item = &'a String;

pub fn vars(&self) -> SecretfileKeys

Return an iterator over the environment variables listed in this file.

Important traits for SecretfileKeys<'a>

impl<'a> Iterator for SecretfileKeys<'a> type Item = &'a String;

pub fn files(&self) -> SecretfileKeys

Return an iterator over the credential files listed in this file.

Trait Implementations

impl Clone for Secretfile

fn clone(&self) -> Secretfile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secretfile

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

Formats the value using the given formatter.

impl FromStr for Secretfile

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Secretfile>

Parses a string s to return a value of this type.