Trait salak::Environment[−][src]

pub trait Environment: Sync + Send + Sized {
    fn require_with_options<T: FromEnvironment>(
        &self, 
        name: &str, 
        disable_placeholder: bool, 
        mut_option: &mut EnvironmentOption
    ) -> Result<T, PropertyError>;

    fn contains(&self, name: &str) -> bool { ... }

    fn require<T: FromEnvironment>(
        &self, 
        name: &str
    ) -> Result<T, PropertyError> { ... }

    fn require_raw<T: FromEnvironment>(
        &self, 
        name: &str
    ) -> Result<T, PropertyError> { ... }

    fn require_or<T: FromEnvironment>(
        &self, 
        name: &str, 
        default: T
    ) -> Result<T, PropertyError> { ... }

    fn get<T: FromEnvironment>(&self, name: &str) -> Option<T> { ... }

    fn get_or<T: FromEnvironment>(&self, name: &str, default: T) -> T { ... }
}

An environment for getting properties in multiple PropertySources.

Required methods

fn require_with_options<T: FromEnvironment>(
    &self,
    name: &str,
    disable_placeholder: bool,
    mut_option: &mut EnvironmentOption
) -> Result<T, PropertyError>[src]

Get value with options.

  1. disable_placeholder can disable placeholder parsing.
  2. mut_option can add default values.
Loading content...

Provided methods

fn contains(&self, name: &str) -> bool[src]

Check if the environment has property.

fn require<T: FromEnvironment>(&self, name: &str) -> Result<T, PropertyError>[src]

Get required value, or return error.

fn require_raw<T: FromEnvironment>(
    &self,
    name: &str
) -> Result<T, PropertyError>[src]

Get required raw value without parsing placeholders, or return error.

fn require_or<T: FromEnvironment>(
    &self,
    name: &str,
    default: T
) -> Result<T, PropertyError>[src]

Get required value, if not exists then return default value, otherwise return error.

fn get<T: FromEnvironment>(&self, name: &str) -> Option<T>[src]

Get optional value, this function will ignore property parse error.

fn get_or<T: FromEnvironment>(&self, name: &str, default: T) -> T[src]

Get value or using default, this function will ignore property parse error.

Loading content...

Implementors

impl Environment for Salak[src]

impl Environment for SourceRegistry[src]

impl<E: Environment> Environment for PlaceholderResolver<E>[src]

Loading content...