Struct PolicySet 

pub struct PolicySet { /* private fields */ }

Represents a set of Policys

Implementations

impl PolicySet

pub fn new() -> Self

Create a fresh empty PolicySet

pub fn add(&mut self, policy: Policy) -> Result<(), PolicySetError>

Add a Policy to the PolicySet.

pub fn merge_policyset( &mut self, other: &PolicySet, rename_duplicates: bool, ) -> Result<LinkedHashMap<PolicyID, PolicyID>, PolicySetError>

Merges this PolicySet with another PolicySet. This PolicySet is modified while the other PolicySet remains unchanged.

The flag rename_duplicates controls the expected behavior when a PolicyID in this and the other PolicySet conflict.

When rename_duplicates is false, conflicting PolicyIDs result in a occupied PolicySetError.

Otherwise, when rename_duplicates is true, conflicting PolicyIDs from the other PolicySet are automatically renamed to avoid conflict. This renaming is returned as a Hashmap from the old PolicyID to the renamed PolicyID.

pub fn remove_static( &mut self, policy_id: &PolicyID, ) -> Result<Policy, PolicySetPolicyRemovalError>

Remove a static Policy`` from the PolicySet`.

pub fn add_static(&mut self, policy: StaticPolicy) -> Result<(), PolicySetError>

Add a StaticPolicy to the PolicySet.

pub fn add_template(&mut self, t: Template) -> Result<(), PolicySetError>

Add a template to the policy set. If a link, static policy or template with the same name already exists, this will error.

pub fn remove_template( &mut self, policy_id: &PolicyID, ) -> Result<Template, PolicySetTemplateRemovalError>

Remove a template from the policy set. This will error if any policy is linked to the template. This will error if policy_id is not a template.

pub fn get_linked_policies( &self, template_id: &PolicyID, ) -> Result<impl Iterator<Item = &PolicyID>, PolicySetGetLinksError>

Get the list of policies linked to template_id. Returns all p in links s.t. p.template().id() == template_id

pub fn link( &mut self, template_id: PolicyID, new_id: PolicyID, values: HashMap<SlotId, EntityUID>, ) -> Result<&Policy, LinkingError>

Attempt to create a new template linked policy and add it to the policy set. Returns a references to the new template linked policy if successful.

Errors for two reasons

1. The the passed SlotEnv either does not match the slots in the templates
2. The passed link Id conflicts with an Id already in the set

pub fn unlink( &mut self, policy_id: &PolicyID, ) -> Result<Policy, PolicySetUnlinkError>

Unlink policy_id If it is not a link this will error

pub fn policies(&self) -> impl Iterator<Item = &Policy>

Iterate over all policies

pub fn into_policies(self) -> impl Iterator<Item = Policy>

Consume the PolicySet, producing an iterator of all the policies in it

pub fn all_templates(&self) -> impl Iterator<Item = &Template>

Iterate over everything stored as template, including static policies. Ie: all_templates() should equal templates() ++ static_policies().map(|p| p.template())

pub fn templates(&self) -> impl Iterator<Item = &Template>

Iterate over templates with slots

pub fn static_policies(&self) -> impl Iterator<Item = &Policy>

Iterate over all of the static policies.

pub fn is_empty(&self) -> bool

Returns true iff the PolicySet is empty

pub fn get_template_arc(&self, id: &PolicyID) -> Option<Arc<Template>>

Lookup a template by policy id, returns Option<Arc<Template>>

pub fn get_template(&self, id: &PolicyID) -> Option<&Template>

Lookup a template by policy id, returns Option<&Template>

pub fn get(&self, id: &PolicyID) -> Option<&Policy>

Lookup an policy by policy id

pub fn try_from_iter<T: IntoIterator<Item = Policy>>( iter: T, ) -> Result<Self, PolicySetError>

Attempt to collect an iterator over policies into a PolicySet

Trait Implementations

impl Clone for PolicySet

fn clone(&self) -> PolicySet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolicySet

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

Formats the value using the given formatter.

impl Default for PolicySet

fn default() -> PolicySet

Returns the “default value” for a type.

impl Display for PolicySet

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

Formats the value using the given formatter.

impl From<PolicySet> for LiteralPolicySet

fn from(pset: PolicySet) -> Self

Converts to this type from the input type.

impl PartialEq for PolicySet

fn eq(&self, other: &PolicySet) -> 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 TryFrom<LiteralPolicySet> for PolicySet

Converts a LiteralPolicySet into a PolicySet, ensuring the invariants are met Every Policy must point to a Template that exists in the set.

type Error = ReificationError

The type returned in the event of a conversion error.

fn try_from(pset: LiteralPolicySet) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PolicySet> for PolicySet

type Error = PolicySetFromJsonError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for PolicySet

impl StructuralPartialEq for PolicySet