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

pub enum Environment {
    Development,
    Staging,
    Production,
}

An enum corresponding to the valid configuration environments.

Variants

The development environment.

The staging environment.

The production environment.

Methods

impl Environment
[src]

[src]

Returns true if self is Environment::Development.

Example

use rocket::config::Environment;

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

[src]

Returns true if self is Environment::Staging.

Example

use rocket::config::Environment;

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

[src]

Returns true if self is Environment::Production.

Example

use rocket::config::Environment;

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

impl Environment
[src]

[src]

Retrieves the "active" environment as determined by the ROCKET_ENV environment variable. If ROCKET_ENV is not set, returns Development.

Errors

Returns a BadEnv ConfigError if ROCKET_ENV contains an invalid environment name.

Trait Implementations

impl Hash for Environment
[src]

[src]

Feeds this value into the given [Hasher]. Read more

1.3.0
[src]

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

impl PartialEq for Environment
[src]

[src]

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0
[src]

This method tests for !=.

impl Eq for Environment
[src]

impl Debug for Environment
[src]

[src]

Formats the value using the given formatter.

impl Clone for Environment
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl Copy for Environment
[src]

impl FromStr for Environment
[src]

The associated error which can be returned from parsing.

[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);

impl Display for Environment
[src]

[src]

Formats the value using the given formatter. Read more