Struct RedactionPolicy 

pub struct RedactionPolicy {
    pub schema: String,
    pub classes: BTreeMap<FieldClass, Action>,
    pub fields: Vec<FieldOverride>,
    pub content_events: Vec<String>,
}

A redaction policy, rustev.redaction/1 (3.4.1). Parse it with RedactionPolicy::parse_validated; a policy that has not passed RedactionPolicy::validate is never applied.

Fields

schema: String

classes: BTreeMap<FieldClass, Action>

Class-wide actions; an unnamed class takes its default (3.4.3).

fields: Vec<FieldOverride>

Per-field overrides, each naming one catalogue field exactly.

content_events: Vec<String>

Catalogue content fields whose GenAI content events may be emitted.

Implementations

impl RedactionPolicy

pub fn parse_validated(bytes: &[u8]) -> Result<Self, PolicyError>

Parse and validate (3.4.1, 3.4.2).

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

Every refusal of 3.4.2, naming the entry; the first one found.

pub fn policy_id(&self) -> RedactionPolicyId

The policy’s identity, sha256: of its canonical bytes (3.4.1).

pub fn class_action(&self, class: FieldClass) -> Action

The class action: the classes entry, else the class default.

pub fn action(&self, field: &str, class: FieldClass) -> Action

The effective action for field holding a value of class (3.4.4): allow for a fixed field, else its fields override, else its class’s entry, else the class default.

pub fn reader_action(&self, field: &str) -> Option<Action>

The action a reader that does not know the value’s class applies to field (3.11.3): a fixed field is allow; an override applies as written; a field with a fixed class takes that class’s action; a field under the lineage rule (3.3.2) takes the most withholding action among every class the rule can assign, so the reader never shows more than the policy allows for the value’s actual class. None for a key outside the catalogue.

pub fn needs_key(&self) -> bool

Whether any action this policy can apply is digest, which needs a key (3.4.5).

pub fn view(&self, field: &str, attr: &TraceAttr) -> View

How a reader holding no key shows one attribute written as attr under the key field (3.11.3): drop withholds it; allow shows it as written; digest shows it only if the line marks it digest; truncate{bytes} cuts a value marked allow or truncated and shows a digest as is. A key outside the catalogue is never shown.

Trait Implementations

impl Clone for RedactionPolicy

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 RedactionPolicy

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

Formats the value using the given formatter.

impl Default for RedactionPolicy

fn default() -> Self

The default policy (3.4.3): every class at its default action, no override, no content event. Also the effective policy when the host supplies none.

impl<'de> Deserialize<'de> for RedactionPolicy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Document for RedactionPolicy

const SCHEMA: &'static str = REDACTION

The schema string this document carries (spec 002, 3.2.1).

const LIMITS: ParseLimits = DESCRIPTOR_V1

The limit set its bytes are scanned against (spec 002, 3.2.5).

fn schema(&self) -> &str

The value of the document’s own schema field.

fn parse(bytes: &[u8]) -> Result<Self, DocumentError>

Scan, deserialize and check the schema string.

fn canonical(&self) -> Result<Vec<u8>, CanonicalError>

The canonical bytes (spec 002, 3.3.1).

fn record_canonical(&self) -> Result<Vec<u8>, CanonicalError>

where Self: PartialEq,

The record canonical bytes (spec 004, 5.6): the canonical bytes, with finite fractional numbers written in shortest round-trip form.

fn record_digest(&self) -> Result<ContentDigest, CanonicalError>

where Self: PartialEq,

sha256(SCHEMA || 0x00 || record canonical bytes) (spec 004, 3.1.6). Equal to the identity of an identified document.

impl Eq for RedactionPolicy

impl Identified for RedactionPolicy

type Id = RedactionPolicyId

fn id(&self) -> Result<Self::Id, CanonicalError>

sha256(SCHEMA || 0x00 || canonical bytes) (spec 002, 3.3.2).

impl JsonSchema for RedactionPolicy

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RedactionPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RedactionPolicy

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RedactionPolicy