pub struct MachineWriter<T, S: ?Sized = NoSchema> { /* private fields */ }
Expand description

Type-safe machine output implementation of crate::ToolIO

Implementations§

source§

impl<T, S: ?Sized> MachineWriter<T, S>

source

pub fn new_buffers<'a, O, E>( format: Option<Format>, stdout: O, stderr: E ) -> Self
where O: Write + 'static, E: Write + 'static,

Create a new writer that doesn’t support machine output at all, with the given streams underlying it.

source

pub fn new(format: Option<Format>) -> Self

Create a new Writer with the specified format.

Passing None for format implies no output via the machine function.

source

pub fn new_test(format: Option<Format>, test_buffers: &TestBuffers) -> Self

Returns a writer backed by string buffers that can be extracted after the writer is done with

source§

impl<T, S> MachineWriter<T, S>
where T: Serialize, S: ?Sized + MaybeSchema,

source

pub fn machine_many<I: IntoIterator<Item = T>>( &mut self, output: I ) -> Result<(), Error>

Write the items from the iterable object to standard output.

This is a no-op if is_machine returns false.

source

pub fn machine(&mut self, output: &T) -> Result<(), Error>

Write the item to standard output.

This is a no-op if is_machine returns false.

source

pub fn machine_or<D: Display>(&mut self, value: &T, or: D) -> Result<(), Error>

If this object is outputting machine output, print the item’s machine representation to stdout. Otherwise, print the display item given.

source

pub fn machine_or_else<F, R>(&mut self, value: &T, f: F) -> Result<(), Error>
where F: FnOnce() -> R, R: Display,

If this object is outputting machine output, prints the item’s machine representation to stdout. Otherwise, call the closure with the object and print the result.

Trait Implementations§

source§

impl<T, S> ToolIO for MachineWriter<T, S>
where T: Serialize, S: ?Sized + MaybeSchema,

§

type OutputItem = T

The type of object that is expected for the Self::item call (or any machine output writing functions that may be added by an implementation)
source§

const OUTPUT_SCHEMA: Option<StaticType> = S::SCHEMA

The schema the output item is expected to follow.
source§

fn is_machine_supported() -> bool

Whether this can theoretically support machine output given the right configuration.
source§

fn is_machine(&self) -> bool

Returns true if the receiver was configured to output for machines.
source§

fn item(&mut self, value: &T) -> Result<(), Error>
where T: Display,

Displays the item in whatever formatted style is most appropriate based on is_machine and the underlying implementation
source§

fn stderr(&mut self) -> &mut Box<dyn Write>

Returns an error stream that errors can be written to.
source§

fn print(&mut self, value: impl Display) -> Result<(), Error>

Writes the value to standard output without a newline. Read more
source§

fn line(&mut self, value: impl Display) -> Result<(), Error>

Writes the value to standard output with a newline. Read more
source§

impl<T, S> Write for MachineWriter<T, S>
where T: Serialize, S: ?Sized + MaybeSchema,

source§

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

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

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

Flush 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, fmt: 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<T, S = NoSchema> !RefUnwindSafe for MachineWriter<T, S>

§

impl<T, S = NoSchema> !Send for MachineWriter<T, S>

§

impl<T, S = NoSchema> !Sync for MachineWriter<T, S>

§

impl<T, S: ?Sized> Unpin for MachineWriter<T, S>

§

impl<T, S = NoSchema> !UnwindSafe for MachineWriter<T, S>

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, 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>,

§

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>,

§

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.