Struct peace_core::AppName

pub struct AppName(/* private fields */);

Name of the application that is run by end users.

This is usually the crate name of the final binary. It needs to be passed in from the executable crate, as it is not possible for Peace to detect it within the library itself.

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

Examples

The following are all examples of valid AppNames:

let _default = app_name!(); // defaults to calling crate name
let _snake = app_name!("snake_case");
let _camel = app_name!("camelCase");
let _pascal = app_name!("PascalCase");

Implementations

impl AppName

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

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

Most users should use the app_name! 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 AppName

fn clone(&self) -> AppName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppName

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

Formats the value using the given formatter.

impl Deref for AppName

type Target = Cow<'static, str>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for AppName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AppName

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

Formats the value using the given formatter.

impl FromStr for AppName

type Err = AppNameInvalidFmt<'static>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AppName, AppNameInvalidFmt<'static>>

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

impl Hash for AppName

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 for AppName

fn eq(&self, other: &AppName) -> 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 Presentable for AppName

fn present<'output, 'life0, 'life1, 'async_trait, PR>( &'life0 self, presenter: &'life1 mut PR ) -> Pin<Box<dyn Future<Output = Result<(), PR::Error>> + 'async_trait>>

where PR: Presenter<'output> + 'async_trait, Self: 'async_trait, 'output: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Presents this data type to the user.

impl Serialize for AppName

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 AppName

type Error = AppNameInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: &'static str) -> Result<AppName, AppNameInvalidFmt<'static>>

Performs the conversion.

impl TryFrom<String> for AppName

type Error = AppNameInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<AppName, AppNameInvalidFmt<'static>>

Performs the conversion.

impl Eq for AppName

impl StructuralPartialEq for AppName