Skip to main content

Output

Struct Output 

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

Structured output writer — all terminal I/O goes through this.

Provides plain output methods (line, blank, raw), styled convenience methods (success, error, warning, info, dim, bold), and implements Write so the standard write!/writeln! macros work directly with ANSI style constants.

§Examples

use tinyharness_ui::output::Output;
use std::io::Write;

let mut out = Output::stdout();
let _ = writeln!(out, "Hello, world!");
out.success("Done.").unwrap();

Implementations§

Source§

impl Output

Source

pub fn stdout() -> Self

Create an Output that writes to stdout.

Source

pub fn stderr() -> Self

Create an Output that writes to stderr.

Source

pub fn new(writer: Box<dyn Write + Send>) -> Self

Create an Output with a custom writer (e.g. a Vec<u8> for testing).

Source

pub fn line(&mut self, text: &str) -> Result<()>

Write text followed by a newline.

Returns io::Result<()>; callers may use let _ = out.line("..."); to ignore errors when writing to stdout/stderr (where failures are rare and typically fatal anyway).

Source

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

Write a blank line (just a newline).

Source

pub fn raw(&mut self, bytes: &[u8]) -> Result<()>

Write raw bytes as-is (no newline appended, no styling applied).

Source

pub fn success(&mut self, msg: &str) -> Result<()>

Write a success message (green) followed by a newline.

Source

pub fn error(&mut self, msg: &str) -> Result<()>

Write an error message (red) followed by a newline.

Source

pub fn warning(&mut self, msg: &str) -> Result<()>

Write a warning message (orange) followed by a newline.

Source

pub fn info(&mut self, msg: &str) -> Result<()>

Write an info message (blue) followed by a newline.

Source

pub fn dim(&mut self, msg: &str) -> Result<()>

Write a dim/gray message followed by a newline.

Source

pub fn bold(&mut self, msg: &str) -> Result<()>

Write a bold message followed by a newline.

Source

pub fn styled_line( &mut self, prefix: &str, text: &str, suffix: &str, ) -> Result<()>

Write a line with custom prefix, text, and suffix, followed by a newline.

Typically used with style constants:

ⓘ
out.styled_line(BOLD, "Header:", RESET);

Trait Implementations§

Source§

impl Write for Output

Source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Output

§

impl !Sync for Output

§

impl !UnwindSafe for Output

§

impl Freeze for Output

§

impl Send for Output

§

impl Unpin for Output

§

impl UnsafeUnpin for Output

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, 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