[][src]Enum rocket::config::Environment

pub enum Environment {
    Development,
    Staging,
    Production,
}

An enum corresponding to the valid configuration environments.

Variants

Development

The development environment.

Staging

The staging environment.

Production

The production environment.

Methods

impl Environment[src]

pub fn active() -> Result<Environment, ConfigError>[src]

Retrieves the "active" environment as determined by the ROCKET_ENV environment variable. If ROCKET_ENV is not set, returns Development when the application was compiled in debug mode and Production when the application was compiled in release mode.

Errors

Returns a BadEnv ConfigError if ROCKET_ENV is set and contains an invalid or unknown environment name.

pub fn is_dev(self) -> bool[src]

Returns true if self is Environment::Development.

Example

use rocket::config::Environment;

assert!(Environment::Development.is_dev());
assert!(!Environment::Production.is_dev());

pub fn is_stage(self) -> bool[src]

Returns true if self is Environment::Staging.

Example

use rocket::config::Environment;

assert!(Environment::Staging.is_stage());
assert!(!Environment::Production.is_stage());

pub fn is_prod(self) -> bool[src]

Returns true if self is Environment::Production.

Example

use rocket::config::Environment;

assert!(Environment::Production.is_prod());
assert!(!Environment::Staging.is_prod());

Trait Implementations

impl PartialEq<Environment> for Environment[src]

#[must_use] fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

impl Copy for Environment[src]

impl Clone for Environment[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Eq for Environment[src]

impl Hash for Environment[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

Feeds a slice of this type into the given [Hasher]. Read more

impl Debug for Environment[src]

impl Display for Environment[src]

impl FromStr for Environment[src]

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>[src]

Parses a configuration environment from a string. Should be used indirectly via str's parse method.

Examples

Parsing a development environment:

use rocket::config::Environment;

let env = "development".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Development);

let env = "dev".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Development);

let env = "devel".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Development);

Parsing a staging environment:

use rocket::config::Environment;

let env = "staging".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Staging);

let env = "stage".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Staging);

Parsing a production environment:

use rocket::config::Environment;

let env = "production".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Production);

let env = "prod".parse::<Environment>();
assert_eq!(env.unwrap(), Environment::Production);

Auto Trait Implementations

impl Send for Environment

impl Sync for Environment

impl Unpin for Environment

impl UnwindSafe for Environment

impl RefUnwindSafe for Environment

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> From<T> for 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.

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

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

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

impl<T> Typeable for T where
    T: Any

fn get_type(&self) -> TypeId

Get the TypeId of this object.

impl<T> IntoCollection<T> for T

impl<T, I> AsResult<T, I> for T where
    I: Input, 

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]