Struct StreamSummary 

pub struct StreamSummary {
    pub byte_len: usize,
    pub line_count: usize,
    pub snippet: String,
    pub truncated: bool,
    pub redacted: bool,
}

Bounded and redacted stream summary.

Fields

byte_len: usize

Original stream byte length before redaction or truncation.

line_count: usize

Original stream line count before redaction or truncation.

snippet: String

Redacted snippet retained in memory.

truncated: bool

Whether the redacted snippet was truncated.

redacted: bool

Whether any obvious secret-looking text was redacted.

Implementations

impl StreamSummary

pub const fn empty() -> Self

Creates an empty stream summary.

pub fn from_bytes(bytes: &[u8], limit: usize) -> Self

Creates a bounded stream summary from bytes.

pub fn from_text(text: &str, limit: usize) -> Self

Creates a bounded stream summary from text.

Trait Implementations

impl Clone for StreamSummary

fn clone(&self) -> StreamSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamSummary

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

Formats the value using the given formatter.

impl Default for StreamSummary

fn default() -> StreamSummary

Returns the “default value” for a type.

impl Eq for StreamSummary

impl PartialEq for StreamSummary

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamSummary