Struct cedar_policy_core::ast::Name

pub struct Name { /* private fields */ }

This is the Name type used to name types, functions, etc. The name can include namespaces. Clone is O(1).

Implementations

impl Name

pub fn new( basename: Id, path: impl IntoIterator<Item = Id>, loc: Option<Loc>, ) -> Self

A full constructor for Name

pub fn unqualified_name(id: Id) -> Self

Create a Name with no path (no namespaces).

pub fn parse_unqualified_name(s: &str) -> Result<Self, ParseErrors>

Create a Name with no path (no namespaces). Returns an error if s is not a valid identifier.

pub fn type_in_namespace( basename: Id, namespace: Name, loc: Option<Loc>, ) -> Name

Given a type basename and a namespace (as a Name itself), return a Name representing the type’s fully qualified name

pub fn loc(&self) -> Option<&Loc>

Get the source location

pub fn basename(&self) -> &Id

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

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

Get the namespace of the Name, as components

pub fn namespace(&self) -> String

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

Examples:

• foo::bar –> the namespace is "foo"
• bar –> the namespace is ""
• foo::bar::baz –> the namespace is "foo::bar"

pub fn prefix_namespace_if_unqualified(&self, namespace: Option<Name>) -> Name

Prefix the name with a optional namespace When the name is not an Id, it doesn’t make sense to prefix any namespace and hence this method returns a copy of self When the name is an Id, prefix it with the optional namespace e.g., prefix A::B`` with Some(C)orNoneproducesA::BprefixAwithSome(B::C)yieldsB::C::A`

pub fn is_unqualified(&self) -> bool

Test if a Name is an Id

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Name

Deserialize a Name using from_normalized_str This deserialization implementation is used in the JSON schema format.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl From<Id> for Name

A shortcut for Name::unqualified_name

fn from(value: Id) -> Self

Converts to this type from the input type.

impl FromNormalizedStr for Name

fn describe_self() -> &'static str

Short string description of the Self type, to be used in error messages. What are we trying to parse?

fn from_normalized_str(s: &str) -> Result<Self, ParseErrors>

Create a Self by parsing a string, which is required to be normalized. That is, the input is required to roundtrip with the Display impl on Self: Self::from_normalized_str(x).to_string() == x must hold.

impl FromStr for Name

type Err = ParseErrors

The associated error which can be returned from parsing.

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

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

impl Hash for Name

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 Name

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

Restrict a value to a certain interval.

impl PartialEq for Name

PartialEq implementation ignores the loc.

fn eq(&self, other: &Self) -> 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 Name

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

Serialize a Name using its Display implementation This serialization implementation is used in the JSON schema format.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Name> for Id

Convert a Name to an Id The error type is the unit type because the reason the conversion fails is obvious

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Name) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Name