PolicyBuilder

Struct PolicyBuilder 

Source
pub struct PolicyBuilder { /* private fields */ }
Expand description

Builder for creating Policy instances with a fluent API

§Examples

use core_policy::{PolicyBuilder, PolicyRuleBuilder, Action, Resource};

let policy = PolicyBuilder::new("admin-policy")
    .add_rule_with(|rule| {
        rule.for_peer("12D3KooWAlice...")
            .allow(Action::All)
            .on(Resource::All)
    })
    .add_rule_with(|rule| {
        rule.for_peer("12D3KooWBob...")
            .allow(Action::Read)
            .on(Resource::File("/docs/*".into()))
    })
    .with_metadata("owner", "alice")
    .build()
    .unwrap();

Implementations§

Source§

impl PolicyBuilder

Source

pub fn new(name: impl Into<String>) -> Self

Create a new policy builder with default validity (30 days)

Source

pub fn with_timestamp(self, timestamp: u64) -> Self

Set the policy issuance timestamp (Unix seconds).

Required for valid time-based policies. If not set, defaults to 0.

Source

pub const fn valid_for(self, duration_secs: u64) -> Self

Set policy validity duration in seconds

Source

pub fn add_rule_with<F>(self, f: F) -> Self

Add a rule using a builder function

Source

pub fn add_rule(self, rule: PolicyRule) -> Self

Add a pre-constructed rule

Source

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add metadata to the policy

Source

pub fn build(self) -> Result<Policy>

Build the Policy, returning an error if validation fails

§Errors

Returns an error if policy validation fails (see Policy::validate())

Trait Implementations§

Source§

impl Debug for PolicyBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.