Struct Id 

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

Unique identifier for any entity in the diagram, Cow<'static, str> newtype.

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

Examples

use disposition_model_common::{id, Id};

let id_compile_time_checked = id!("example_id");
let id_runtime_checked = Id::new("example_id").unwrap();

assert_eq!(id_compile_time_checked, id_runtime_checked);
assert_eq!(id_runtime_checked.as_str(), "example_id");

Implementations

impl Id

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

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

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

impl Id

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

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

pub fn into_inner(self) -> Cow<'static, str>

Returns the inner Cow<'static, str>.

pub fn as_str(&self) -> &str

Returns the &str held by this ID.

Trait Implementations

impl AsRef<str> for Id

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s> Borrow<str> for &'s Id

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Borrow<str> for Id

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Id

fn clone(&self) -> Id

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl Deref for Id

type Target = Cow<'static, str>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Id

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl From<Id> for EdgeId

fn from(id: Id) -> Self

Converts to this type from the input type.

impl From<Id> for EntityTypeId

fn from(id: Id) -> Self

Converts to this type from the input type.

impl FromStr for Id

type Err = IdInvalidFmt<'static>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Id, IdInvalidFmt<'static>>

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

impl Hash for Id

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 Id

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Id

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 Id

type Error = IdInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: &'static str) -> Result<Id, IdInvalidFmt<'static>>

Performs the conversion.

impl TryFrom<String> for Id

type Error = IdInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Id, IdInvalidFmt<'static>>

Performs the conversion.

impl Eq for Id

impl StructuralPartialEq for Id