Struct OutputManager 

pub struct OutputManager { /* private fields */ }

Manages output formatting and display.

Provides methods for outputting success results, collections, and errors in either text or JSON format based on configuration.

Implementations

impl OutputManager

pub fn new(format: OutputFormat) -> Self

Create a new output manager with the specified format.

pub fn success<T>(&mut self, data: T) -> Result<ExitCode>

where T: Serialize + Display,

Output a successful result.

In JSON mode, wraps the data in a success response. In text mode, displays the data using its Display implementation. Broken pipe errors are silently ignored to support piping to commands like head.

pub fn item<T>( &mut self, item: Option<T>, entity: &str, name: &str, ) -> Result<ExitCode>

where T: Serialize + Display,

Output a single item or indicate not found.

If the item is Some, outputs it as success. If None, outputs a not found message.

pub fn not_found(&mut self, entity: &str, name: &str) -> Result<ExitCode>

Output a not found result. Returns ExitCode::NotFound (3) to indicate the entity was not found. Broken pipe errors are silently ignored.

pub fn collection<T, I>( &mut self, items: I, entity_name: &str, ) -> Result<ExitCode>

where T: Serialize + Display, I: IntoIterator<Item = T>,

Output a collection with proper formatting.

Empty collections are treated as not found (returns ExitCode::NotFound). Non-empty collections are displayed as a list (returns ExitCode::Success). Broken pipe errors are silently ignored.

pub fn error(&mut self, error: &IndexError) -> Result<ExitCode>

Output an error with suggestions. Returns the appropriate ExitCode based on the error type. Broken pipe errors are silently ignored.

pub fn progress(&mut self, message: &str) -> Result<()>

Output progress information (text mode only).

In JSON mode, progress messages are suppressed to avoid polluting the JSON output. Broken pipe errors are silently ignored.

pub fn info(&mut self, message: &str) -> Result<()>

Output informational message (text mode only). Broken pipe errors are silently ignored.

pub fn symbol_contexts( &mut self, contexts: impl IntoIterator<Item = SymbolContext>, entity_name: &str, ) -> Result<ExitCode>

Output a collection of SymbolContext items.

This method is specifically designed for SymbolContext to ensure consistent formatting across all retrieve commands.

Returns

• ExitCode::Success - When contexts are found and output successfully
• ExitCode::NotFound - When the collection is empty

Performance

Collects the iterator once to check for empty and get count. This is necessary for proper error handling and text formatting.

pub fn unified<T>(&mut self, output: UnifiedOutput<'_, T>) -> Result<ExitCode>

where T: Serialize + Display,

Output a UnifiedOutput structure with dynamic data handling.

This method handles all OutputData variants appropriately:

• Items: Simple list display
• Grouped: Hierarchical display by category
• Contextual: Rich nested structure with relationships
• Ranked: Sorted display with scores
• Single: Single item display
• Empty: Not found handling

Performance

Uses zero-cost abstractions from UnifiedOutput. Display formatting relies on the UnifiedOutput’s Display implementation.

Returns

The exit code from the UnifiedOutput structure