Struct EntityTypeName

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

Represents an entity type name. Consists of a namespace and the type name.

An EntityTypeName can can be constructed using EntityTypeName::from_str or by calling parse() on a string. Unlike EntityId::from_str, this can fail, so it is important to properly handle an Err result.

let id : Result<EntityTypeName, _> = "Namespace::Type".parse();

Implementations

impl EntityTypeName

pub fn basename(&self) -> &str

Get the basename of the EntityTypeName (ie, with namespaces stripped).

let type_name = EntityTypeName::from_str("MySpace::User").unwrap();
assert_eq!(type_name.basename(), "User");

pub fn namespace_components(&self) -> impl Iterator<Item = &str>

Get the namespace of the EntityTypeName, as components

let type_name = EntityTypeName::from_str("Namespace::MySpace::User").unwrap();
let mut components = type_name.namespace_components();
assert_eq!(components.next(), Some("Namespace"));
assert_eq!(components.next(), Some("MySpace"));
assert_eq!(components.next(), None);

pub fn namespace(&self) -> String

Get the full namespace of the EntityTypeName, as a single string.

let type_name = EntityTypeName::from_str("Namespace::MySpace::User").unwrap();
let components = type_name.namespace();
assert_eq!(components,"Namespace::MySpace");

Trait Implementations

impl Clone for EntityTypeName

fn clone(&self) -> EntityTypeName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityTypeName

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

Formats the value using the given formatter.

impl Display for EntityTypeName

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

Formats the value using the given formatter.

impl FromStr for EntityTypeName

This FromStr implementation requires the normalized representation of the type name. See https://github.com/cedar-policy/rfcs/pull/9/.

type Err = ParseErrors

The associated error which can be returned from parsing.

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

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

impl Hash for EntityTypeName

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 EntityTypeName

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

fn eq(&self, other: &EntityTypeName) -> 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 PartialOrd for EntityTypeName

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

type From = EntityType

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl Eq for EntityTypeName

impl StructuralPartialEq for EntityTypeName