Skip to main content

Output

Struct Output 

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

Sink for plugin output. Plugins write here instead of println! so output stays consistent with the requested mode and verbosity.

Implementations§

Source§

impl Output

Source

pub fn for_context(ctx: &Context, writer: impl Write + Send + 'static) -> Self

Build an Output from a Context and a writer (typically stdout).

Source

pub fn with_writer(self, writer: impl Write + Send + 'static) -> Self

Replace the inner writer. Useful in tests.

Source

pub const fn mode(&self) -> OutputMode

Reported output mode.

Source

pub const fn color(&self) -> ColorMode

Reported color preference.

Source

pub fn human(&mut self, msg: &str)

Write a human-readable message terminated by a newline.

Suppressed when the log level is LogLevel::Quiet or the output mode is OutputMode::Json.

Source

pub fn json<T: Serialize>(&mut self, value: &T) -> Result<()>

Serialize a value as a single line of JSON to the output.

Always emits regardless of log level (errors are surfaced via Self::error).

§Errors

Returns an Error::JsonParse if serialization fails or an Error::Io if writing to the underlying writer fails.

Source

pub fn error(&mut self, err: &dyn Error)

Print an error using the writer’s diagnostic conventions.

Source

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

Flush the underlying writer.

§Errors

Forwards I/O failures from the underlying writer.

Auto Trait Implementations§

§

impl Freeze for Output

§

impl !RefUnwindSafe for Output

§

impl Send for Output

§

impl !Sync for Output

§

impl Unpin for Output

§

impl UnsafeUnpin for Output

§

impl !UnwindSafe 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> 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> 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<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