Enum Destination

Source
pub enum Destination<'a> {
    Terminal(StandardStream),
    Buffered(BufferWriter, Buffer),
    UnColoredRaw(&'a mut (dyn Write + Send)),
    ColoredRaw(Ansi<&'a mut (dyn Write + Send)>),
}
Expand description

Emit destinations provide four ways to emit.

Note: All custom writers must implement two traits Write and Send.

§Examples

  1. If you want to use writer stdout or stderr, you can use the method from_stderr and from_stdout.
use compiler_base_error::Destination;
use termcolor::ColorChoice;
// stdout
let dest_stdout = Destination::from_stdout(ColorChoice::Never);
// stderr
let dest_stderr = Destination::from_stderr(ColorChoice::Never);
  1. If you want to use custom writer
use compiler_base_error::Destination;
use termcolor::Ansi;
use std::io::Write;
use std::io;

// 1. Define a custom writer.
struct MyWriter {
    content: String,
}

// 2. Implement trait `Write`.
impl Write for MyWriter {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        if let Ok(s) = std::str::from_utf8(buf) {
            self.content.push_str(s)
        } else {
            self.content = "Nothing".to_string();
        }
        Ok(buf.len())
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}
// 3. Implement trait `Send`.
unsafe impl Send for MyWriter {}

// 4. Define a destiation.
let mut my_writer = MyWriter{ content: String::new() };
Destination::UnColoredRaw(&mut my_writer);

// 5. If your custom writer supports color.
Destination::ColoredRaw(Ansi::new(&mut my_writer));

Variants§

§

Terminal(StandardStream)

Emit to stderr/stdout by stream.

§

Buffered(BufferWriter, Buffer)

Save by the ‘Buffer’, and then Emit to stderr/stdout by the ‘Buffer’ through the ‘BufferWriter’.

§

UnColoredRaw(&'a mut (dyn Write + Send))

Emit to a destiation without color.

§

ColoredRaw(Ansi<&'a mut (dyn Write + Send)>)

Emit to a customize destiation with color.

Implementations§

Source§

impl<'a> Destination<'a>

Source

pub fn from_stderr(choice: ColorChoice) -> Self

New a stderr destination. ColorChoice is used to determine whether the output content has been colored.

Source

pub fn from_stdout(choice: ColorChoice) -> Self

New a stdout destination. ColorChoice is used to determine whether the output content has been colored.

Source

pub fn supports_color(&self) -> bool

Returns true if and only if the underlying Destination supports colors.

Source

pub fn set_color(&mut self, color: &ColorSpec) -> Result<()>

Set color for the Destination by ColorSpec. Subsequent writes to this writer will use these settings until either reset() is called or new color settings are set. If there was a problem resetting the color settings, then an error is returned.

Source

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

Reset the current color settings for Destination to their original settings. If there was a problem resetting the color settings, then an error is returned.

Trait Implementations§

Source§

impl<'a> Drop for Destination<'a>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'a> Write for Destination<'a>

Source§

fn write(&mut self, bytes: &[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<'a> !Freeze for Destination<'a>

§

impl<'a> !RefUnwindSafe for Destination<'a>

§

impl<'a> Send for Destination<'a>

§

impl<'a> !Sync for Destination<'a>

§

impl<'a> Unpin for Destination<'a>

§

impl<'a> !UnwindSafe for Destination<'a>

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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
Source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,