Struct figment::Profile [−][src]
pub struct Profile(_);
Expand description
A configuration profile: effectively a case-insensitive string.
See the top-level docs for details.
Implementations
Constructs a profile with the name name
.
Example
use figment::Profile; let profile = Profile::new("staging"); assert_eq!(profile, "staging"); assert_eq!(profile, "STAGING");
A const
to construct a profile with the name name
.
Example
use figment::Profile; const STAGING: Profile = Profile::const_new("staging"); assert_eq!(STAGING, "staging"); assert_eq!(STAGING, "STAGING");
Constructs a profile from the value of the environment variable with
name name
, if one is present. The search for name
is
case-insensitive.
Example
use figment::{Profile, Jail}; Jail::expect_with(|jail| { jail.set_env("MY_PROFILE", "secret"); assert_eq!(Profile::from_env("MY_PROFILE"), Some("secret".into())); assert_eq!(Profile::from_env("MY_PROFILE"), Some("secret".into())); assert_eq!(Profile::from_env("MY_profile"), Some("secret".into())); assert_eq!(Profile::from_env("other_profile"), None); Ok(()) });
Constructs a profile from the value of the environment variable with
name name
, if one is present, or default
if one is not. The search
for name
is case-insensitive.
Example
use figment::{Profile, Jail}; Jail::expect_with(|jail| { jail.set_env("MY_PROFILE", "secret"); assert_eq!(Profile::from_env_or("MY_PROFILE", "default"), "secret"); assert_eq!(Profile::from_env_or("MY_profile", "default"), "secret"); assert_eq!(Profile::from_env_or("other_prof", "default"), "default"); Ok(()) });
Converts self
into an &UncasedStr
.
Example
use figment::Profile; let profile = Profile::new("static"); let string = profile.as_str();
Returns true
iff self
case-insensitively starts with prefix
.
Example
use figment::Profile; let profile = Profile::new("static"); assert!(profile.starts_with("STAT")); assert!(profile.starts_with("stat")); assert!(profile.starts_with("static"));
Returns true
iff self
is neither “default” nor “global”.
Example
use figment::Profile; let profile = Profile::new("static"); assert!(profile.is_custom()); assert!(!Profile::Default.is_custom()); assert!(!Profile::Global.is_custom());
Methods from Deref<Target = UncasedStr>
Returns self
as an &str
.
Example
use uncased::UncasedStr; let uncased_str = UncasedStr::new("Hello!"); assert_eq!(uncased_str.as_str(), "Hello!"); assert_ne!(uncased_str.as_str(), "hELLo!");
Returns the length, in bytes, of self
.
Example
use uncased::UncasedStr; let uncased_str = UncasedStr::new("Hello!"); assert_eq!(uncased_str.len(), 6);
Returns true
if self
has a length of zero bytes.
Examples
use uncased::UncasedStr; let s = UncasedStr::new(""); assert!(s.is_empty()); let s = UncasedStr::new("not empty"); assert!(!s.is_empty());
Returns true
if self
starts with any casing of the string string
;
otherwise, returns false
.
Example
use uncased::UncasedStr; let uncased_str = UncasedStr::new("MoOO"); assert!(uncased_str.starts_with("moo")); assert!(uncased_str.starts_with("MOO")); assert!(uncased_str.starts_with("MOOO")); assert!(!uncased_str.starts_with("boo")); let uncased_str = UncasedStr::new("Bèe"); assert!(!uncased_str.starts_with("Be")); assert!(uncased_str.starts_with("Bè")); assert!(uncased_str.starts_with("Bè")); assert!(uncased_str.starts_with("bèe")); assert!(uncased_str.starts_with("BèE"));
Trait Implementations
type Target = UncasedStr
type Target = UncasedStr
The resulting type after dereferencing.
Dereferences the value.
Deserialize this value from the given Serde deserializer. Read more
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for Profile
impl UnwindSafe for Profile
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V