Struct RedactionWriter 

pub struct RedactionWriter<'session> { /* private fields */ }

Restricted writer for one redaction operation.

Implementations use structural scopes to classify every field explicitly. The writer borrows one transaction and never publishes intermediate text.

Type Parameters

• 'session: Exclusive borrow of the transaction receiving this value.

Examples

use qubit_redact::{Redact, RedactionWriter, Redactor, Sensitivity};

struct Credential(&'static str);

impl Redact for Credential {
    fn write_redacted(&self, writer: &mut RedactionWriter<'_>) {
        writer.record("Credential", |fields| {
            fields.sensitive_at_least(Sensitivity::Secret, "token", || self.0);
        });
    }
}

let output = Redactor::standard().redact_text(&Credential("raw-token"));
assert!(!output.text().as_str().contains("raw-token"));

use qubit_redact::{Redact, RedactionWriter};

struct Value;
impl Redact for Value {
    fn write_redacted(&self, writer: &mut RedactionWriter<'_>) {
        let _ = writer.redact_json_text("{\"token\":\"secret\"}");
    }
}

Implementations

impl<'session> RedactionWriter<'session>

pub fn literal(&mut self, text: &'static str)

Writes a trusted static structural literal.

Parameters

• text: Trusted static structure; omitted after the frame closes.

pub fn unredacted<T>(&mut self, value: &T) -> &mut Self

where T: Debug + ?Sized,

Writes explicitly trusted dynamic content without redaction.

Warning

This method is an explicit trust-boundary bypass: it never consults field policy, even when the active policy is strict. It is only for content that the caller has independently established as safe to expose. Never pass credentials, user-controlled diagnostic data, or a value whose classification depends on runtime policy; use a redaction-aware field method instead.

Type Parameters

• T: Possibly unsized value rendered with Debug.

Parameters

• value: Caller-verified safe value; formatting is skipped during inspection.

Returns

This writer for subsequent writes.

pub fn unmarked<T>(&mut self, value: &T) -> &mut Self

where T: Debug + ?Sized,

Writes a field without applying redaction policy.

Warning

This is the semantic alias used for an intentionally unmarked field and has the same trust-boundary requirements as Self::unredacted.

Type Parameters

• T: Possibly unsized value rendered with Debug.

Parameters

• value: Caller-verified safe value with no policy classification.

Returns

This writer for subsequent writes.

pub fn record<F>(&mut self, name: &'static str, configure: F)

where F: for<'writer> FnOnce(&mut RedactionFields<'writer, 'session>),

Writes a named record through a field scope.

Type Parameters

• F: Callback accepting the scope for any temporary writer borrow.

Parameters

• name: Trusted static type label; an empty label emits no name.
• configure: One-shot callback that writes through the borrowed scope.

pub fn tuple<F>(&mut self, name: &'static str, configure: F)

where F: for<'writer> FnOnce(&mut RedactionFields<'writer, 'session>),

Writes a named tuple through a field scope.

Type Parameters

• F: Callback accepting the scope for any temporary writer borrow.

Parameters

• name: Trusted static type label; an empty label emits no name.
• configure: One-shot callback that writes through the borrowed scope.

pub fn transparent<F>(&mut self, configure: F)

where F: for<'writer> FnOnce(&mut RedactionFields<'writer, 'session>),

Writes exactly one field without a nominal record or tuple wrapper.

This is intended for transparent domain newtypes. The configured field still passes through the ordinary classified field operations and the same admission limits as a structured value.

Type Parameters

• F: Callback accepting the scope for any temporary writer borrow.

Parameters

• configure: One-shot callback that writes through the borrowed scope.

pub fn sequence<F>(&mut self, configure: F)

where F: for<'writer> FnOnce(&mut RedactionItems<'writer, 'session>),

Writes a bracketed sequence through an item scope.

Type Parameters

• F: Callback accepting the scope for any temporary writer borrow.

Parameters

• configure: One-shot callback that writes through the borrowed scope.

pub fn map<F>(&mut self, configure: F)

where F: for<'writer> FnOnce(&mut RedactionEntries<'writer, 'session>),

Writes a braced map through an entry scope.

Type Parameters

• F: Callback accepting the scope for any temporary writer borrow.

Parameters

• configure: One-shot callback that writes through the borrowed scope.

pub fn variant<F>( &mut self, enum_name: &'static str, variant_name: &'static str, configure: F, )

where F: for<'writer> FnOnce(&mut RedactionFields<'writer, 'session>),

Writes a named enum variant through a field scope.

Type Parameters

• F: Callback accepting the scope for any temporary writer borrow.

Parameters

• enum_name: Trusted static enum label.
• variant_name: Trusted static variant label.
• configure: One-shot callback that writes through the borrowed scope.