Enum cedar_policy_core::ast::Literal

pub enum Literal {
    Bool(bool),
    Long(i64),
    String(SmolStr),
    EntityUID(Arc<EntityUID>),
}

First-class values which may appear as literals in Expr::Lit.

Note that the auto-derived PartialEq and Eq are total equality – using == to compare Literals of different types results in false, not a type error.

Literal does not include set or record types. Although Cedar has syntax for set literals (e.g., [2, -7, 8]), these can include arbitrary expressions (e.g., [2+3, principal.foo]), so they have to become Expr::Set, not Expr::Lit.

Cloning is O(1).

Variants

Bool(bool)

Boolean value

Long(i64)

Signed integer value

String(SmolStr)

String value

EntityUID(Arc<EntityUID>)

Entity, represented by its UID. To get the actual Entity, you have to look up this UID in a Store or Slice.

Implementations

impl Literal

pub fn is_ref(&self) -> bool

Check if this literal is an entity reference

This is used for policy headers, where some syntax is required to be an entity reference.

Trait Implementations

impl Clone for Literal

fn clone(&self) -> Literal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Literal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Literal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Literal

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

Formats the value using the given formatter.

impl From<&str> for Literal

Create a Literal directly from an &str

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Arc<EntityUID>> for Literal

fn from(ptr: Arc<EntityUID>) -> Self

Converts to this type from the input type.

impl From<EntityUID> for Literal

Create a Literal directly from an EntityUID

fn from(e: EntityUID) -> Self

Converts to this type from the input type.

impl From<Literal> for Expr

fn from(lit: Literal) -> Expr

Converts to this type from the input type.

impl From<SmolStr> for Literal

fn from(s: SmolStr) -> Self

Converts to this type from the input type.

impl From<String> for Literal

Create a Literal directly from a String

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<bool> for Literal

Create a Literal directly from a bool

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<i64> for Literal

Create a Literal directly from an i64

fn from(i: i64) -> Self

Converts to this type from the input type.

impl FromStr for Literal

type Err = ParseErrors

The associated error which can be returned from parsing.

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

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

impl Hash for Literal

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 Literal

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticallyTyped for Literal

fn type_of(&self) -> Type

Get the object’s type

impl Eq for Literal

impl StructuralPartialEq for Literal