Enum Destination

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

Emit destinations provide four ways to emit.

• Destination::Terminal: Emit by StandardStream
• Destination::Buffered: Emit by BufferWriter, you can save content in Buffer first, and then emit the Buffer to BufferWriter on flush.
• Destination::UnColoredRaw: Emit by a custom writer that does not support colors.
• Destination::ColoredRaw: Emit by a custom writer that supports colors.

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);

2. 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

impl<'a> Destination<'a>

pub fn from_stderr(choice: ColorChoice) -> Self

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

pub fn from_stdout(choice: ColorChoice) -> Self

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

pub fn supports_color(&self) -> bool

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

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.

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

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

fn drop(&mut self)

Executes the destructor for this type.

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

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

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.

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

Attempts to write an entire buffer into this writer.

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.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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