Struct peace_cfg::ItemId

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

Unique identifier for an ItemId, Cow<'static, str> newtype.

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

Examples

The following are all examples of valid ItemIds:

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

Design Note

TODO: Experiment with upgrades.

For backward compatibility and migrating items from old IDs to new IDs, e.g. when they were deployed with an old version of the automation software, there needs to be a way to:

• Read state using the old ID.
• Either clean up that state, or migrate that state into an Item with the new ID.

Implementations

impl ItemId

pub fn new(s: &'static str) -> Result<ItemId, ItemIdInvalidFmt<'static>>

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

Most users should use the item_id! 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 ItemId

fn clone(&self) -> ItemId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemId

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

Formats the value using the given formatter.

impl Deref for ItemId

type Target = Cow<'static, str>

The resulting type after dereferencing.

fn deref(&self) -> &<ItemId as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ItemId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ItemId

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

Formats the value using the given formatter.

impl FromStr for ItemId

type Err = ItemIdInvalidFmt<'static>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ItemId, ItemIdInvalidFmt<'static>>

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

impl Hash for ItemId

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

where __H: Hasher,

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 ItemId

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

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

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

Presents this data type to the user.

impl Serialize for ItemId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&'static str> for ItemId

type Error = ItemIdInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: &'static str) -> Result<ItemId, ItemIdInvalidFmt<'static>>

Performs the conversion.

impl TryFrom<String> for ItemId

type Error = ItemIdInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<ItemId, ItemIdInvalidFmt<'static>>

Performs the conversion.

impl Eq for ItemId

impl StructuralPartialEq for ItemId