Struct TrackingId 

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

A validated package tracking identifier, e.g. PKG-9ED9285C.

Construct one with TrackingId::generate (default policy), IdGenerator::generate (custom policy), or TrackingId::parse when reading an ID back from storage or user input.

With the serde feature an ID serialises as a plain string, and deserialising runs the same validation as TrackingId::parse — a TrackingId that arrived over the wire is as trustworthy as one built by hand.

Examples

use smart_package_tracker::TrackingId;

let id = TrackingId::generate()?;
assert!(id.as_str().starts_with("PKG-"));

let parsed: TrackingId = "PKG-9ED9285C".parse()?;
assert_eq!(parsed.prefix(), "PKG");
assert_eq!(parsed.body(), "9ED9285C");

Implementations

impl TrackingId

pub fn generate() -> Result<Self>

Available on crate feature os-rng only.

Generate an ID with the default policy: PKG- plus 32 bits of entropy.

See IdGenerator for why 32 bits is often too narrow, and how to widen it. Requires the os-rng feature (enabled by default).

Errors

Returns Error::Entropy if the OS entropy source is unavailable.

pub fn parse(raw: &str) -> Result<Self>

Parse and validate an existing ID.

Validation is structural: one separator, a non-empty prefix and body, only A-Z and 0-9, and a bounded total length. It deliberately does not check entropy width or check characters, because those are properties of a generator policy rather than of the format — use IdGenerator::validate for that.

Errors

Returns Error::InvalidTrackingId describing the first violation.

pub fn as_str(&self) -> &str

The full ID as a string slice.

pub fn prefix(&self) -> &str

The part before the separator, e.g. PKG.

pub fn body(&self) -> &str

The part after the separator, e.g. 9ED9285C.

pub fn into_string(self) -> String

Consume the ID and return the underlying String.

Trait Implementations

impl AsRef<str> for TrackingId

fn as_ref(&self) -> &str

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

impl Clone for TrackingId

fn clone(&self) -> TrackingId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrackingId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TrackingId

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialise and validate.

Deriving this would accept any string at all, which would let a value that TrackingId::parse rejects — a lowercase ID, or one carrying a second separator whose tail is then silently ignored by body — enter the type through the back door.

impl Display for TrackingId

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

Formats the value using the given formatter.

impl Eq for TrackingId

impl FromStr for TrackingId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl Hash for TrackingId

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 TrackingId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TrackingId

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

Available on crate feature serde only.

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 TrackingId

impl TryFrom<&str> for TrackingId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for TrackingId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self>

Performs the conversion.