Struct CollectionPolicy 

pub struct CollectionPolicy {
    pub owner_mode: OwnerMode,
    pub create: Rule,
    pub update: Rule,
    pub delete: Rule,
    pub read: Rule,
    pub filter: Option<String>,
    pub readonly_fields: Vec<String>,
    pub private_fields: Vec<String>,
    pub explicit: bool,
}

A compiled collection policy.

Fields

owner_mode: OwnerMode

create: Rule

update: Rule

delete: Rule

read: Rule

filter: Option<String>

readonly_fields: Vec<String>

private_fields: Vec<String>

explicit: bool

Whether this policy was explicitly declared (vs the implicit default).

Implementations

impl CollectionPolicy

pub fn is_read_scoped(&self) -> bool

Whether reads of this collection are restricted in any way.

pub fn allows_create(&self, actor: &Actor) -> bool

Authorize a create.

pub fn allows_mutation( &self, actor: &Actor, record: Option<&Value>, kind: MutationKind, resolved_filter: Option<&str>, ) -> Decision

Authorize an update/delete against the existing record.

resolved_filter is the tenant filter with #var# already resolved; if present, the record must also satisfy it (otherwise a tenant could mutate another tenant’s row by guessing its id).

pub fn read_scope( &self, actor: &Actor, filter_ctx: &HashMap<String, Value>, ) -> ReadScope

Compute the read scope for actor. filter_ctx supplies #var# values (user/session) for the tenant filter.

pub fn resolved_filter( &self, filter_ctx: &HashMap<String, Value>, ) -> Option<String>

The resolved tenant filter for mutation checks, or None.

pub fn stamp_owner(&self, map: &mut Map<String, Value>, actor: &Actor)

Stamp _owner into a new record’s field map (create only).

pub fn sanitize_input(&self, map: &mut Map<String, Value>)

Remove client-supplied values the server manages: the _owner field (never trust it from input) and any fields.readonly.

Trait Implementations

impl Clone for CollectionPolicy

fn clone(&self) -> CollectionPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionPolicy

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

Formats the value using the given formatter.

impl Default for CollectionPolicy

fn default() -> Self

The implicit owner-protected default for undeclared collections.