Struct RedactionTextOutput 

pub struct RedactionTextOutput { /* private fields */ }

Published policy-transformed text and completion metadata from one operation.

Incomplete output retains the selected policy’s confidentiality guarantees. Truncated and Exhausted describe incomplete diagnostics; they do not authorize disclosure of fields protected by that policy. As with RedactedText, disabled policies and explicitly unredacted operations can deliberately preserve source content. Callers can reject or replace incomplete text when their own contract requires completeness.

Examples

use qubit_redact::RedactionCompletion;
use qubit_redact::Redactor;

let output = Redactor::strict().redact_field("password", "raw-secret");
assert_eq!(output.summary().completion(), RedactionCompletion::Complete);

Implementations

impl RedactionTextOutput

pub const fn text(&self) -> &RedactedText

Borrows the final text.

Returns

Borrowed final text, including safe incomplete representations.

pub const fn summary(&self) -> &RedactionSummary

Borrows the execution summary.

Returns

Borrowed completion, reasons, and resource use for this output.

pub fn complete_text(&self) -> Result<&RedactedText, &RedactionSummary>

Borrows the final text when the operation completed without truncation or exhaustion.

Errors

Returns the execution summary when the safe output was truncated or exhausted. The error reports completeness; it does not imply that the published text is unsafe for diagnostics.

Returns

Borrowed text only for Complete; otherwise the borrowed execution summary.

pub fn text_or_marker(&self, marker: &str) -> Cow<'_, str>

Borrows the final text or returns an escaped caller-selected marker when the operation was incomplete.

The complete path does not allocate. An incomplete marker is escaped before publication so control characters cannot forge diagnostic log structure. The marker is selected after the transaction and therefore does not consume its resource budget.

Parameters

• marker: Fallback escaped outside the completed operation’s byte budget.

Returns

Borrowed complete text, or an owned escaped marker for incomplete output.

pub fn into_complete_text(self) -> Result<RedactedText, RedactionSummary>

Consumes a complete output and returns its final text.

Errors

Returns the execution summary when the safe output was truncated or exhausted. The error reports completeness; it does not imply that the published text is unsafe for diagnostics.

Returns

Owned text only for Complete; otherwise the owned execution summary.

pub fn into_text_or_marker(self, marker: &str) -> RedactedText

Consumes the output and returns a caller-selected marker when it is incomplete.

The marker is escaped before becoming RedactedText, so it remains safe for diagnostic presentation.

Parameters

• marker: Fallback escaped outside the completed operation’s byte budget.

Returns

Owned complete text, or a wrapper around the escaped fallback marker.

pub fn into_parts(self) -> (RedactedText, RedactionSummary)

Consumes the output and returns both parts.

Returns

The owned text and summary, in that order, without checking completeness.

Trait Implementations

impl Clone for RedactionTextOutput

fn clone(&self) -> RedactionTextOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactionTextOutput

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

Formats the value using the given formatter.

impl Eq for RedactionTextOutput

impl PartialEq for RedactionTextOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionTextOutput