Struct allow_me::PolicyBuilder

pub struct PolicyBuilder<V, M, S> { /* fields omitted */ }

A policy builder, responsible for parsing policy definition and constructing Policy struct.

It handles policy definition versioning and allows fine-grained configuration of Policy components.

Implementations

impl PolicyBuilder<DefaultValidator, Default, DefaultSubstituter>

pub fn from_json(
    json: impl Into<String>
) -> PolicyBuilder<DefaultValidator, Default, DefaultSubstituter>

Constructs a PolicyBuilder from provided json policy definition, with default configuration.

Call to this method does not parse or validate the json, all heavy work is done in build method.

pub fn from_definition(
    definition: PolicyDefinition
) -> PolicyBuilder<DefaultValidator, Default, DefaultSubstituter>

Constructs a PolicyBuilder from provided policy definition struct, with default configuration.

Call to this method does not validate the definition, all heavy work is done in build method.

impl<V, M, S, E> PolicyBuilder<V, M, S> where
    V: PolicyValidator<Error = E>,
    M: ResourceMatcher,
    S: Substituter,
    E: StdError + Sync + Into<Box<dyn StdError>> + 'static, 

pub fn with_validator<V1>(self, validator: V1) -> PolicyBuilder<V1, M, S>

Specifies the PolicyValidator to validate the policy definition.

pub fn with_matcher<M1>(self, matcher: M1) -> PolicyBuilder<V, M1, S>

Specifies the ResourceMatcher to use with Policy.

pub fn with_substituter<S1>(self, substituter: S1) -> PolicyBuilder<V, M, S1>

Specifies the Substituter to use with Policy.

pub fn with_default_decision(self, decision: Decision) -> Self

Specifies the default decision that Policy will return if no rules match the request.

pub fn build(self) -> Result<Policy<M, S>>

Builds a Policy consuming the builder.

This method does all the heavy lifting of deserializing json, validating and constructing the policy rules tree.

Errors

Returns PolicyValidator::Error if any.