Struct RetentionPolicy 

pub struct RetentionPolicy { /* private fields */ }

The periods a deployment keeps its records for.

Implementations

impl RetentionPolicy

pub fn declare( years: u16, categories: &BTreeMap<String, u16>, origins: &BTreeMap<String, u16>, map: &CategoryMap, ) -> Result<Self, RetentionError>

The policy, inside the Union, that keeps every record years, the data of each category of categories and from each origin of origins as long as they say, in whole years, each category read as CategoryMap::category reads it.

Errors

A RetentionError for a period under FLOOR_YEARS, a code that names no category, and an empty or malformed origin key.

pub fn declare_within( bounds: &Bounds, default: Period, categories: &BTreeMap<String, Period>, origins: &BTreeMap<String, Period>, map: &CategoryMap, ) -> Result<Self, RetentionError>

The policy within bounds that keeps every record default, the data of each category of categories and from each origin of origins (by its key: its endpoint, or the system_id of an origin that names no endpoint) as long as they say.

Errors

A RetentionError for a period outside the bounds, a code that names no category, and an empty or malformed origin key.

pub fn bounds(&self) -> &Bounds

The bounds the policy was declared within.

pub fn origins(&self) -> impl Iterator<Item = &str>

The origin keys the policy names.

pub fn longest(&self) -> Period

The longest period the policy declares anywhere, by the fewest days each spans; RetentionPolicy::retain compares by the end date each gives a record instead.

pub fn retain<'a>( &self, recorded: Timestamp, classified: &Classification, origins: impl IntoIterator<Item = &'a str>, ) -> Retention

How long the record of an access made at recorded, classified as classified, from the origins keyed origins, is kept.

The period is the longest of the default, each category’s and each origin’s, and the longest declared anywhere for an access that is unclassified in whole or in part, each compared by the end date it gives this record. The ground is the first of these, in that order, that calls for the period.

Trait Implementations

impl Clone for RetentionPolicy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetentionPolicy

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

Formats the value using the given formatter.

impl Default for RetentionPolicy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RetentionPolicy

impl PartialEq for RetentionPolicy

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RetentionPolicy