Struct cedar_policy_core::ast::Template

pub struct Template { /* private fields */ }

Top level structure for a policy template. Contains both the AST for template, and the list of open slots in the template.

Implementations

impl Template

pub fn new( id: PolicyID, annotations: Annotations, effect: Effect, principal_constraint: PrincipalConstraint, action_constraint: ActionConstraint, resource_constraint: ResourceConstraint, non_head_constraint: Expr ) -> Self

Construct a Template from its components

pub fn principal_constraint(&self) -> &PrincipalConstraint

Get the principal constraint on the body

pub fn action_constraint(&self) -> &ActionConstraint

Get the action constraint on the body

pub fn resource_constraint(&self) -> &ResourceConstraint

Get the resource constraint on the body

pub fn non_head_constraints(&self) -> &Expr

Get the non-head constraint on the body

pub fn id(&self) -> &PolicyID

Get the PolicyID of this template

pub fn new_id(&self, id: PolicyID) -> Self

Clone this Policy with a new ID

pub fn effect(&self) -> Effect

Get the Effect (Permit or Deny) of this template

pub fn annotation(&self, key: &AnyId) -> Option<&Annotation>

Get data from an annotation.

pub fn annotations(&self) -> impl Iterator<Item = (&AnyId, &Annotation)>

Get all annotation data.

pub fn condition(&self) -> Expr

Get the condition expression of this template.

This will be a conjunction of the template’s head constraints (on principal, resource, and action); the template’s “when” conditions; and the negation of each of the template’s “unless” conditions.

pub fn slots(&self) -> impl Iterator<Item = &SlotId>

List of open slots in this template

pub fn is_static(&self) -> bool

Check if this template is a static policy

Static policies can be linked without any slots, and all links will be identical.

pub fn check_binding( template: &Template, values: &HashMap<SlotId, EntityUID> ) -> Result<(), LinkingError>

Ensure that every slot in the template is bound by values, and that no extra values are bound in values This upholds invariant (values total map)

pub fn link( template: Arc<Template>, new_id: PolicyID, values: HashMap<SlotId, EntityUID> ) -> Result<Policy, LinkingError>

Attempt to create a template-linked policy from this template. This will fail if values for all open slots are not given. new_instance_id is the PolicyId for the created template-linked policy.

pub fn link_static_policy(p: StaticPolicy) -> (Arc<Template>, Policy)

Take a static policy and create a template and a template-linked policy for it. They will share the same ID

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Template

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Template

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

Formats the value using the given formatter.

impl From<Template> for Policy

Convert AST to EST

fn from(ast: Template) -> Policy

Converts to this type from the input type.

impl From<Template> for TemplateBody

fn from(val: Template) -> Self

Converts to this type from the input type.

impl From<TemplateBody> for Template

fn from(body: TemplateBody) -> Self

Converts to this type from the input type.

impl Hash for Template

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 PartialEq for Template

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Template

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Template> for StaticPolicy

type Error = UnexpectedSlotError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Template

impl StructuralPartialEq for Template