Enum rocket::config::Environment

source ·
pub enum Environment {
    Development,
    Staging,
    Production,
}
Expand description

An enum corresponding to the valid configuration environments.

Variants§

§

Development

The development environment.

§

Staging

The staging environment.

§

Production

The production environment.

Implementations§

source§

impl Environment

source

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

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.

source

pub fn is_dev(self) -> bool

Returns true if self is Environment::Development.

§Example
use rocket::config::Environment;

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

pub fn is_stage(self) -> bool

Returns true if self is Environment::Staging.

§Example
use rocket::config::Environment;

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

pub fn is_prod(self) -> bool

Returns true if self is Environment::Production.

§Example
use rocket::config::Environment;

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

Trait Implementations§

source§

impl Clone for Environment

source§

fn clone(&self) -> Environment

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Environment

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Environment

source§

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

Formats the value using the given formatter. Read more
source§

impl FromStr for Environment

source§

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

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);
source§

type Err = ()

The associated error which can be returned from parsing.
source§

impl Hash for Environment

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Environment

source§

fn eq(&self, other: &Environment) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Environment

source§

impl Eq for Environment

source§

impl StructuralPartialEq for Environment

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn as_result(self) -> Result<T, ParseErr<I>>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Typeable for T
where T: Any,

source§

fn get_type(&self) -> TypeId

Get the TypeId of this object.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V