Struct Id 

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

A validated Cedar identifier.

Wraps a SmolStr that has been checked to be a valid Cedar identifier (not a reserved keyword, no special characters, etc.).

The only way to create an Id is through Id::new() (which validates that the input is a valid identifier) or through conversion from other validated identifier representations. Accessing the inner string is free via as_str() or into_smolstr().

let id = Id::new("userName").expect("valid identifier");
assert_eq!(id.as_str(), "userName");

// Reserved keywords are rejected:
assert!(Id::new("if").is_err());
assert!(Id::new("true").is_err());

Implementations

impl Id

pub fn new(s: impl AsRef<str>) -> Result<Id, PstConstructionError>

Create a new Id, validating that the string is a legal Cedar identifier.

pub fn as_str(&self) -> &str

Get the underlying string as a &str. Zero-cost.

pub fn into_smolstr(self) -> SmolStr

Consume the Id and return the underlying SmolStr. Zero-cost.

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 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<(), Error>

Formats the value using the given formatter.

impl Display for Id

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

Formats the value using the given formatter.

impl Eq for Id

impl From<Id> for Id

Infallible: ast::Id is already validated.

fn from(id: Id) -> Id

Converts to this type from the input type.

impl Hash for Id

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

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Id

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