Struct Template

pub struct Template { /* private fields */ }

Policy template datatype

Implementations

impl Template

pub fn parse( id: Option<PolicyId>, src: impl AsRef<str>, ) -> Result<Self, ParseErrors>

Attempt to parse a Template from source. Returns an error if the input is a static policy (i.e., has no slots). If id is Some, then the resulting template will have that id. If the id is None, the parser will use the default “policy0”. The behavior around None may change in the future.

pub fn id(&self) -> &PolicyId

Get the PolicyId of this Template

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

Clone this Template with a new PolicyId

pub fn effect(&self) -> Effect

Get the Effect (Forbid or Permit) of this Template

pub fn annotation(&self, key: impl AsRef<str>) -> Option<&str>

Get an annotation value of this Template. If the annotation is present without an explicit value (e.g., @annotation), then this function returns Some(""). Returns None when the annotation is not present or when key is not a valid annotation identifier.

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

Iterate through annotation data of this Template as key-value pairs. Annotations which do not have an explicit value (e.g., @annotation), are included in the iterator with the value "".

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

Iterate over the open slots in this Template

pub fn principal_constraint(&self) -> TemplatePrincipalConstraint

Get the scope constraint on this policy’s principal

pub fn action_constraint(&self) -> ActionConstraint

Get the scope constraint on this policy’s action

pub fn resource_constraint(&self) -> TemplateResourceConstraint

Get the scope constraint on this policy’s resource

pub fn from_json( id: Option<PolicyId>, json: Value, ) -> Result<Self, PolicyFromJsonError>

Create a Template from its JSON representation. Returns an error if the input is a static policy (i.e., has no slots). If id is Some, the policy will be given that Policy Id. If id is None, then “JSON policy” will be used. The behavior around None may change in the future.

pub fn to_json(&self) -> Result<Value, PolicyToJsonError>

Get the JSON representation of this Template.

pub fn to_cedar(&self) -> String

Get the human-readable Cedar syntax representation of this template. This function is primarily intended for rendering JSON policies in the human-readable syntax, but it will also return the original policy text when given a policy parsed from the human-readable syntax.

It also does not format the policy according to any particular rules. Policy formatting can be done through the Cedar policy CLI or the cedar-policy-formatter crate.

pub fn get_valid_request_envs( &self, s: &Schema, ) -> impl Iterator<Item = RequestEnv>

Get the valid RequestEnvs for this template, according to the schema.

That is, all the RequestEnvs in the schema for which this template is not trivially false.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a duplicate of the value.

const 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 Display for Template

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

Formats the value using the given formatter.

impl From<&Template> for TemplateBody

Available on crate feature protobufs only.

fn from(v: &Template) -> Self

Converts to this type from the input type.

impl From<&TemplateBody> for Template

Available on crate feature protobufs only.

fn from(v: &TemplateBody) -> Self

Converts to this type from the input type.

impl FromStr for Template

type Err = ParseErrors

The associated error which can be returned from parsing.

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

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

impl PartialEq for Template

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

Tests for self and other values to be equal, and is used by ==.

const 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 Protobuf for Template

Available on crate feature protobufs only.

fn encode(&self) -> Vec<u8>

Encode into protobuf format. Returns a freshly-allocated buffer containing binary data.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

Decode the binary data in buf, producing something of type Self

impl Eq for Template