Struct PolicyModule 

#[non_exhaustive]
pub struct PolicyModule {
    pub applies_to: Option<Vec<String>>,
    pub created_at: DateTime<Utc>,
    pub description: Option<PolicyModuleDescription>,
    pub enabled: bool,
    pub ext: Option<Ext>,
    pub id: PolicyModuleId,
    pub module: PolicyModuleModule,
    pub name: PolicyModuleName,
    pub priority: Option<i64>,
    pub updated_at: DateTime<Utc>,
    pub version: u64,
}

Available on crate feature policy only.

PolicyModule

JSON schema

{
 "title": "PolicyModule",
 "type": "object",
 "required": [
   "createdAt",
   "id",
   "module",
   "name",
   "updatedAt",
   "version"
 ],
 "properties": {
   "appliesTo": {
     "description": "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy).",
     "type": "array",
     "items": {
       "type": "string"
     },
     "uniqueItems": true
   },
   "createdAt": {
     "type": "string",
     "format": "date-time"
   },
   "description": {
     "type": "string",
     "maxLength": 1024
   },
   "enabled": {
     "default": true,
     "type": "boolean"
   },
   "ext": {
     "$ref": "#/definitions/Ext"
   },
   "id": {
     "type": "string",
     "minLength": 1
   },
   "module": {
     "description": "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision.",
     "type": "string",
     "minLength": 1
   },
   "name": {
     "description": "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\").",
     "type": "string",
     "maxLength": 128,
     "minLength": 1
   },
   "priority": {
     "description": "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins.",
     "type": "integer",
     "maximum": 1000.0,
     "minimum": 0.0
   },
   "updatedAt": {
     "type": "string",
     "format": "date-time"
   },
   "version": {
     "type": "integer",
     "minimum": 0.0
   }
 },
 "additionalProperties": false
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

applies_to: Option<Vec<String>>

List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy).

created_at: DateTime<Utc>

description: Option<PolicyModuleDescription>

enabled: bool

ext: Option<Ext>

id: PolicyModuleId

module: PolicyModuleModule

Rego source code. The maintainer’s evaluator entry point is the package’s decision rule, returning a PolicyDecision.

name: PolicyModuleName

Human-readable name (e.g. “default vault policy”, “bank-site step-up”).

priority: Option<i64>

When multiple policies match a request, evaluation order is by priority descending. The first to return a non-null decision wins.

updated_at: DateTime<Utc>

version: u64

Implementations

impl PolicyModule

pub fn builder() -> PolicyModule

Trait Implementations

impl Clone for PolicyModule

fn clone(&self) -> PolicyModule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolicyModule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PolicyModule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PolicyModule> for PolicyModule

fn from(value: PolicyModule) -> PolicyModule

Converts to this type from the input type.

impl Serialize for PolicyModule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PolicyModule> for PolicyModule

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: PolicyModule) -> Result<PolicyModule, ConversionError>

Performs the conversion.