[][src]Struct rualdlib::Aliases

pub struct Aliases {
    pub aliases: Option<BTreeMap<String, String>>,
    pub vars: Option<BTreeMap<String, String>>,
    // some fields omitted
}

Contain aliases and assiociated path

use serde_derive::{Serialize,Deserialize};
use std::collections::BTreeMap;

#[derive(Serialize, Deserialize, Debug)]
pub struct Aliases {
    aliases: Option<BTreeMap<String, String>>,
}

Fields

aliases: Option<BTreeMap<String, String>>vars: Option<BTreeMap<String, String>>

Implementations

impl Aliases[src]

Get alias from rad TOML structure

let home = std::env::var("HOME").unwrap();
let aliases: Aliases = toml::from_str(r#"
[aliases]
Home = '~'
workdir = '~/workdir'
local = '/usr/local'
"#).unwrap();

let alias = "Home";
let pointed = aliases.get(alias);

assert_eq!(pointed, Some(home));

pub fn open(aliases_dir: PathBuf) -> Result<Self>[src]

Open rualdi aliases file from default aliases directory, default directory can be configured by _RAD_ALIASES_DIR env variable.

pub fn save(&self) -> Result<()>[src]

Save rualdi aliases file in default aliases directory, default directory can be configured by _RAD_ALIASES_DIR env variable.

pub fn add(&mut self, alias: String, path: String) -> Result<()>[src]

Add alias on path in aliase configuration file, raise an error if alias already exists.

pub fn add_env(&mut self, alias: String, var_name: String) -> Result<()>[src]

Add environment variable assiociated with an alias configuration file to load it in shell environment, raise an error if environment variable already exists.

pub fn remove(&mut self, alias: String) -> Result<()>[src]

Remove alias on path in aliase configuration file, raise an error if alias not exists.

pub fn remove_env(&mut self, alias: String) -> Result<()>[src]

Remove environment variable associated to an alias in aliase configuration file, raise an error if variable not exists.

pub fn list(&self) -> Option<String>[src]

Get a formatted String conaining aliases/paths found in configuration file

pub fn list_env(&self) -> String[src]

Get a String conaining aliases/vars found in configuration file

pub fn get(&self, alias: &str) -> Option<String>[src]

Search alias in rualdi aliases configuration file, return None if alias not found

pub fn get_env(&self, alias: &str) -> Result<String>[src]

Search environment variable associated to alias in rualdi aliases configuration file, return None if variable not found

Trait Implementations

impl Debug for Aliases[src]

impl<'de> Deserialize<'de> for Aliases[src]

impl Drop for Aliases[src]

impl Serialize for Aliases[src]

Auto Trait Implementations

impl RefUnwindSafe for Aliases

impl Send for Aliases

impl Sync for Aliases

impl Unpin for Aliases

impl UnwindSafe for Aliases

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.