Struct IdentifierName 

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

A validated name for a supplementary standardized identifier.

Names use lowercase kebab-case. Identifiers with dedicated Citum fields, such as doi and isbn, are reserved and cannot be duplicated here.

Implementations

impl IdentifierName

pub fn new(value: impl Into<String>) -> Result<Self, String>

Validate and construct a supplementary identifier name.

Errors

Returns an error when the name is not lowercase kebab-case, does not begin with a letter, or is reserved for a first-class reference field.

pub fn as_str(&self) -> &str

Return the validated wire-format name.

Trait Implementations

impl Borrow<str> for IdentifierName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for IdentifierName

fn clone(&self) -> IdentifierName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentifierName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IdentifierName

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IdentifierName

impl FromStr for IdentifierName

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

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

impl Hash for IdentifierName

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 Ord for IdentifierName

fn cmp(&self, other: &IdentifierName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IdentifierName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IdentifierName

fn partial_cmp(&self, other: &IdentifierName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IdentifierName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IdentifierName