Struct rualdlib::Aliases

pub struct Aliases {
    pub aliases: Option<BTreeMap<String, String>>,
    pub vars: Option<BTreeMap<String, String>>,
    pub colors: Option<BTreeMap<String, String>>,
    pub alias_hash: 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>>

colors: Option<BTreeMap<String, String>>

alias_hash: Option<BTreeMap<String, String>>

Implementations

impl Aliases

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>

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

pub fn save(&self) -> Result<()>

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<()>

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<()>

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<()>

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

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

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

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

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

pub fn list_env(&self) -> String

Get a String conaining aliases/vars found in configuration file

pub fn list_alias(&self) -> Option<String>

pub fn list_alias_completions(&self) -> Option<String>

pub fn list_env_completions(&self) -> Option<String>

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

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

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

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

Trait Implementations

impl Debug for Aliases

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Aliases

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Drop for Aliases

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for Aliases

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

Serialize this value into the given Serde serializer.