StreamingWriter

Struct StreamingWriter 

Source
pub struct StreamingWriter<W> { /* private fields */ }
Expand description

Streaming writer for output.

Controls streaming output with the following behaviors:

  • Streaming formats (json, jsonl, csv, tsv): Output rows immediately.
  • Non-streaming formats (table): Buffer rows up to buffer_limit.

§Output Boundary

  • Output started: When output_started == true (header has been written).
  • Buffer overflow: Returns an error prompting --output json|csv|tsv or --limit.

Implementations§

Source§

impl<W: Write> StreamingWriter<W>

Source

pub fn new( writer: W, formatter: Box<dyn Formatter>, columns: Vec<Column>, limit: Option<usize>, ) -> Self

Create a new StreamingWriter.

§Arguments
  • writer - The output writer (e.g., stdout).
  • formatter - The formatter to use for output.
  • columns - Column definitions for the output.
  • limit - Optional row limit.
Source

pub fn with_buffer_limit(self, buffer_limit: usize) -> Self

Create a new StreamingWriter with a custom buffer limit.

Source

pub fn with_quiet(self, quiet: bool) -> Self

Enable quiet mode (suppress warnings).

Source

pub fn is_quiet(&self) -> bool

Check if quiet mode is enabled.

When quiet mode is enabled, status-only output (OK messages) should be suppressed.

Source

pub fn prepare(&mut self, row_count_hint: Option<usize>) -> Result<()>

Prepare the writer for output.

For streaming formats (json, jsonl, csv, tsv), immediately outputs the header. For non-streaming formats (table), defers header output.

§Arguments
  • row_count_hint - Optional estimated row count (unused for buffer sizing).
Source

pub fn write_row(&mut self, row: Row) -> Result<WriteStatus>

Write a row to the output.

For streaming formats, the row is output immediately. For non-streaming formats, the row is buffered.

§Returns
  • WriteStatus::Continue - Row was written, continue writing.
  • WriteStatus::LimitReached - Row limit reached, stop writing.
§Note

The row is taken by ownership to avoid unnecessary cloning when buffering.

Source

pub fn finish(&mut self) -> Result<()>

Finish output, flushing any buffered rows and writing the footer.

Source

pub fn written_count(&self) -> usize

Returns the number of rows written.

Source

pub fn output_started(&self) -> bool

Returns whether output has started.

Source

pub fn buffered_bytes(&self) -> usize

Returns approximate buffered bytes.

Auto Trait Implementations§

§

impl<W> Freeze for StreamingWriter<W>
where W: Freeze,

§

impl<W> !RefUnwindSafe for StreamingWriter<W>

§

impl<W> Send for StreamingWriter<W>
where W: Send,

§

impl<W> Sync for StreamingWriter<W>
where W: Sync,

§

impl<W> Unpin for StreamingWriter<W>
where W: Unpin,

§

impl<W> !UnwindSafe for StreamingWriter<W>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSend for T
where T: Send,