Struct peace_core::Profile

pub struct Profile(_);

Identifier or namespace to distinguish execution environments.

Example suitable identifiers are:

• "dev_user1"
• "dev_user2"
• "prod_customer1"

Must begin with a letter or underscore, and contain only letters, numbers, and underscores.

Examples

The following are all examples of valid Profiles:

let _snake = profile!("snake_case");
let _camel = profile!("camelCase");
let _pascal = profile!("PascalCase");

Implementations

impl Profile

pub fn new(s: &'static str) -> Result<Self, ProfileInvalidFmt<'_>>

Returns a new Profile if the given &str is valid.

Most users should use the profile! macro as this provides compile time checks and returns a const value.

pub fn is_valid_id(proposed_id: &str) -> bool

Returns whether the provided &str is a valid station identifier.

Methods from Deref<Target = Cow<'static, str>>

pub fn is_borrowed(&self) -> bool

🔬This is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is borrowed, i.e. if to_mut would require additional work.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow = Cow::Borrowed("moo");
assert!(cow.is_borrowed());

let bull: Cow<'_, str> = Cow::Owned("...moo?".to_string());
assert!(!bull.is_borrowed());

pub fn is_owned(&self) -> bool

🔬This is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is owned, i.e. if to_mut would be a no-op.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow: Cow<'_, str> = Cow::Owned("moo".to_string());
assert!(cow.is_owned());

let bull = Cow::Borrowed("...moo?");
assert!(!bull.is_owned());

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Deref for Profile

type Target = Cow<'static, str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Profile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Profile

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

Formats the value using the given formatter.

impl FromStr for Profile

type Err = ProfileInvalidFmt<'static>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Profile, ProfileInvalidFmt<'static>>

Parses a string s to return a value of this type.

impl Hash for Profile

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Profile> for Profile

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Profile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&'static str> for Profile

type Error = ProfileInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: &'static str) -> Result<Profile, ProfileInvalidFmt<'static>>

Performs the conversion.

impl TryFrom<String> for Profile

type Error = ProfileInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Profile, ProfileInvalidFmt<'static>>

Performs the conversion.

impl Eq for Profile

impl StructuralEq for Profile

impl StructuralPartialEq for Profile