Struct Writer

pub struct Writer<O: OutputSink> { /* private fields */ }

Writer handles formatting and delivering output from both the plugin and fuzzer.

Callers can use this object to configure how output should be formatted, suppressed, etc. The underlying OutputSink is responsible for determining where output actually goes. The plugin uses print and error, while the fuzzer uses write_all and log. Fuzzer output can be paused and resumed, with data being buffered between those calls.

Implementations

impl<O: OutputSink> Writer<O>

pub fn new(output: O) -> Self

Creates a new Writer.

This object will display data received by methods like print by formatting it and sending it to the given output sink.

pub fn mute(&mut self, muted: bool)

If true, suppresses output except for plugin errors.

pub fn use_colors(&mut self, use_colors: bool)

If true, embeds ANSI escape sequences in the output to add colors and styles.

pub fn tee<P: AsRef<Path>, S: AsRef<str>>( &self, dirname: P, filename: S, ) -> Result<Writer<O>>

Creates a new Writer that is a clone of this object, except that it duplicates its output and writes it to a file created from dirname and filename.

pub fn print<D: Display>(&self, message: D)

Writes a displayable message to the OutputSink.

This method is used with output from the ffx fuzz plugin.

pub fn println<D: Display>(&self, message: D)

Like print, except that it also adds a newline.

pub fn error<D: Display>(&self, message: D)

Writes a displayable error to the OutputSink.

This method is used with output from the ffx fuzz plugin.

pub fn write_all(&self, buf: &[u8])

Writes bytes directly to the OutputSink.

This method is used with output from the fuzzer. If pause is called, data passed to this method will be buffered until resume is called.

pub fn log(&self, logs_data: LogsData)

Writes a structured log entry to the OutputSink.

This method is used with output from the fuzzer. If pause is called, data passed to this method will be buffered until resume is called.

The display format loosely imitates that of ffx log as implemented by that plugin’s DefaultLogFormatter.

pub fn pause(&self)

Pauses the display of fuzzer output.

When this is called, any data passed to write_all or log will be buffered until resume is called.

pub fn resume(&self)

Resumes the display of fuzzer output.

When this is called, any data passed to write_all or log since pause was invoked will be sent to the OutputSink.

Trait Implementations

impl<O: OutputSink> Clone for Writer<O>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<O: Debug + OutputSink> Debug for Writer<O>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.