Struct BodyCapture 

pub struct BodyCapture<'a> { /* private fields */ }

Borrowed HTTP body bytes with truthful source-length metadata.

Type Parameters

• 'a - Lifetime of the borrowed body bytes.

Examples

use qubit_redact::{Redactor, RedactionReason};
use qubit_redact::formats::http::BodyCapture;

let capture = BodyCapture::truncated(b"prefix", 12).expect("valid source length");
assert_eq!(capture.omitted_len(), Some(6));
let output = Redactor::standard().redact_http_body(capture, None);
assert!(output.summary().reasons().contains(RedactionReason::SourceTruncated));

Implementations

impl<'a> BodyCapture<'a>

pub const fn complete(bytes: &'a [u8]) -> Self

Creates a capture containing the complete source body.

Parameters

• bytes - Complete source body bytes.

Returns

A capture whose total length equals the borrowed slice length.

pub fn prefix(bytes: &'a [u8], max_bytes: usize) -> Self

Captures at most max_bytes from a complete source body.

Parameters

• bytes - Complete source body bytes.
• max_bytes - Maximum prefix length to expose to the redactor.

Returns

A complete capture when the body fits, otherwise a truncated prefix carrying the exact total source length. A zero limit captures an empty prefix of non-empty input.

pub const fn truncated_unknown(bytes: &'a [u8]) -> Self

Creates a capture known to omit an unknown number of source bytes.

Parameters

• bytes - Captured prefix of the source body.

Returns

An infallible truncated capture whose complete source length is unknown.

pub const fn truncated( bytes: &'a [u8], total_len: usize, ) -> Result<Self, BodyCaptureError>

Creates a capture known to omit source bytes.

Parameters

• bytes - Captured prefix of the source body.
• total_len - Exact complete source length, which must exceed the captured prefix length.

Returns

A checked truncated capture.

Errors

Returns BodyCaptureError::InvalidTotalLength when total_len is less than or equal to the captured slice length. Use Self::truncated_unknown when the complete source length is unknown.

pub const fn bytes(self) -> &'a [u8]

Returns the body bytes available before the redactor’s hard budget.

Returns

The borrowed captured byte slice.

pub const fn captured_len(self) -> usize

Returns the number of captured bytes.

Returns

The borrowed slice length.

#![deny(unused_must_use)]
use qubit_redact::formats::http::BodyCapture;

BodyCapture::complete(b"payload").captured_len();

pub const fn total_len(self) -> Option<usize>

Returns the complete source length when known.

Returns

Some(total) for an exact length, or None for a truncated capture whose omitted byte count is unknown.

pub const fn omitted_len(self) -> Option<usize>

Returns the number of source bytes omitted before capture.

Returns

Some(0) for complete input, Some(count) for a known truncated total, or None when the total length is unknown.

pub const fn is_source_truncated(self) -> bool

Reports whether source bytes were omitted before capture.

Returns

true for captures created with Self::prefix when the source does not fit, Self::truncated_unknown, or Self::truncated.

Trait Implementations

impl<'a> Clone for BodyCapture<'a>

fn clone(&self) -> BodyCapture<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for BodyCapture<'a>

impl Debug for BodyCapture<'_>

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

Formats safe capture metadata without exposing body bytes.

Parameters

• formatter - Destination formatting context.

Returns

The formatter result from writing the safe metadata.

Errors

Returns fmt::Error when the destination rejects a write.

impl<'a> Eq for BodyCapture<'a>

impl<'a> PartialEq for BodyCapture<'a>

fn eq(&self, other: &BodyCapture<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for BodyCapture<'a>