Policy

Struct Policy 

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

A policy containing multiple rules

§Security

Fields are private to enforce validation through deserialization. Use Policy::new() or deserialize from TOML/JSON to create instances. The #[serde(try_from)] attribute ensures all deserialized policies are validated against T20 limits (max rules, max name length, etc.).

Implementations§

Source§

impl Policy

Source

pub fn name(&self) -> &str

Get the policy name

Source

pub const fn version(&self) -> u64

Get the policy version

Source

pub const fn issued_at(&self) -> u64

Get the issuance timestamp

Source

pub const fn valid_until(&self) -> u64

Get the expiration timestamp

Source

pub fn rules(&self) -> &[PolicyRule]

Get a reference to the policy rules

Source

pub fn metadata(&self) -> &BTreeMap<String, String>

Get a reference to the metadata

Source

pub fn new( name: impl Into<String>, valid_duration_secs: u64, current_time: u64, ) -> Result<Self>

Create a new empty policy with version 1

§Arguments
  • name - Policy identifier
  • valid_duration_secs - How long this policy is valid (in seconds)
  • current_time - Current Unix timestamp (injected for purity/determinism)
§Errors

Returns PolicyError::NameTooLong if name exceeds MAX_POLICY_NAME_LENGTH

Source

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

Create a policy without timestamps (for testing/legacy)

§Errors

Returns PolicyError::NameTooLong if name exceeds MAX_POLICY_NAME_LENGTH

Source

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

Add a rule to this policy

§Errors

Returns PolicyError::TooManyRules if adding this rule would exceed MAX_RULES_PER_POLICY

Source

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

Add metadata to this policy

Source

pub fn is_allowed( &self, peer_id: &str, action: &Action, resource: &Resource, ) -> bool

Check if a peer is allowed to perform an action on a resource

This method delegates to PolicyAuthorizer (SRP - Single Responsibility Principle). The Policy struct focuses on construction and management, while authorization logic is handled by the dedicated PolicyAuthorizer.

Source

pub fn validate(&self) -> Result<()>

Validate policy (check for conflicts, invalid rules, etc.)

§Errors

Returns PolicyError::InvalidRule if:

  • Policy name is empty
  • Policy has no rules
  • Any rule has an empty peer ID
Source

pub fn from_toml(toml_str: &str) -> Result<Self>

Load policy from TOML string

§Errors

Returns an error if:

  • TOML parsing fails
  • Validation fails (see validate())
Source

pub fn to_toml(&self) -> Result<String>

Serialize policy to TOML string

§Errors

Returns PolicyError::SerializationError if TOML serialization fails

Trait Implementations§

Source§

impl Clone for Policy

Source§

fn clone(&self) -> Policy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Policy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Policy

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Policy

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Policy

§

impl RefUnwindSafe for Policy

§

impl Send for Policy

§

impl Sync for Policy

§

impl Unpin for Policy

§

impl UnwindSafe for Policy

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,