Skip to main content

OutputBuffer

Struct OutputBuffer 

Source
pub struct OutputBuffer { /* private fields */ }
Expand description

Bounded combined stdout/stderr accumulator.

The byte and line ceilings are independent so a single oversized line cannot slip past a line-count-only limit. When either trips, the head and the tail are both retained with a marker in between; head-only truncation would hide a script’s final result, which is usually the part worth reading.

Implementations§

Source§

impl OutputBuffer

Source

pub fn new(limits: &Limits) -> Self

Creates an empty buffer under the configured ceilings.

Source

pub fn push_line(&mut self, line: &str)

Appends one already-rendered line.

Source

pub fn push_fragment(&mut self, fragment: &str)

Appends text without terminating the current line.

This is what echo -n and printf produce; the fragment joins whatever the next write appends, exactly as it would on a real terminal.

Source

pub fn push_block(&mut self, block: &str)

Appends a possibly multi-line block and terminates the line.

Source

pub fn finish(&mut self)

Flushes any unterminated trailing fragment. Call once before rendering.

Source

pub fn is_truncated(&self) -> bool

Reports whether any line was dropped or clamped.

Source

pub fn render(&self) -> String

Renders the retained output, including the truncation marker when one applies.

Trait Implementations§

Source§

impl Debug for OutputBuffer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more