Skip to main content

Formatter

Trait Formatter 

Source
pub trait Formatter {
    // Required method
    fn format(
        &self,
        symbols: &[DisplaySymbol],
        metadata: Option<&FormatterMetadata>,
        streams: &mut OutputStreams,
    ) -> Result<()>;
}
Expand description

Trait for formatting search results

Required Methods§

Source

fn format( &self, symbols: &[DisplaySymbol], metadata: Option<&FormatterMetadata>, streams: &mut OutputStreams, ) -> Result<()>

Format and output symbols using provided output streams

Results should go to streams.write_result() (stdout) Diagnostics should go to streams.write_diagnostic() (stderr)

Metadata is optional - used for structured JSON output with query stats

§Errors

Returns an error if writing to the output streams fails.

Implementors§