Struct RawKey 

pub struct RawKey { /* private fields */ }

A key’s text split into venue, product and id, checked by no product yet.

RawKey::parse splits at the first :, then what comes before it at its first .. The id is everything after the :, so it may hold : and . of its own. The venue and product must be ids (an ASCII lowercase letter, then lowercase letters, digits and -) and the id must not be empty; the id is otherwise kept as written, since only its product knows its canonical form.

It serializes as its text form and deserializes through RawKey::parse.

use polyoxide_venue::RawKey;

let raw = RawKey::parse("acme.events:FED-25DEC:yes")?;
assert_eq!(raw.venue().as_str(), "acme");
assert_eq!(raw.product().as_str(), "events");
assert_eq!(raw.id(), "FED-25DEC:yes");
assert!(RawKey::parse("acme:spot").is_err());

Implementations

impl RawKey

pub fn parse(text: &str) -> Result<Self, KeyError>

Splits text, written venue.product:id.

Errors

KeyError::Malformed when there is no :, no . before it, a venue or product that is not an id, or an empty id.

pub fn venue(&self) -> &VenueId

The venue, as written.

pub fn product(&self) -> &ProductId

The product, as written.

pub fn id(&self) -> &str

The id, as written.

Trait Implementations

impl Clone for RawKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RawKey

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

Deserialize this value from the given Serde deserializer.

impl Display for RawKey

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

Formats the value using the given formatter.

impl Eq for RawKey

impl FromStr for RawKey

type Err = KeyError

The associated error which can be returned from parsing.

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

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

impl Hash for RawKey

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 RawKey

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RawKey

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RawKey