Struct AnnotatedOutput 

pub struct AnnotatedOutput {
    pub visual: String,
    pub annotations: Vec<WidgetAnnotation>,
}

Combined visual and semantic output from a rendered frame.

This pairs the visual text representation (what a human would see) with structured annotation data (what a machine can parse).

Example

use envision::annotation::{AnnotatedOutput, AnnotationRegistry, Annotation, with_annotations};
use envision::backend::CaptureBackend;
use ratatui::Terminal;

let backend = CaptureBackend::new(80, 24);
let mut terminal = Terminal::new(backend).unwrap();

let registry = with_annotations(|| {
    terminal.draw(|frame| {
        // Render widgets with annotations...
    }).unwrap();
});

let output = AnnotatedOutput::from_backend_and_registry(terminal.backend(), &registry);
assert!(!output.visual.is_empty());

Fields

visual: String

The visual text representation of the rendered frame.

annotations: Vec<WidgetAnnotation>

Structured annotations for each widget in the frame.

Implementations

impl AnnotatedOutput

pub fn from_backend_and_registry( backend: &CaptureBackend, registry: &AnnotationRegistry, ) -> Self

Creates an AnnotatedOutput from a CaptureBackend and an AnnotationRegistry.

The visual output is the plain text representation of the backend’s current buffer. The annotations are converted from the registry’s region data into a flat list of WidgetAnnotation values.

pub fn from_visual_and_registry( visual: String, registry: &AnnotationRegistry, ) -> Self

Creates an AnnotatedOutput from a visual string and an AnnotationRegistry.

This is useful when you already have the visual output as a string and want to pair it with annotation data.

pub fn annotation_count(&self) -> usize

Returns the number of annotations.

pub fn is_empty(&self) -> bool

Returns true if there are no annotations.

pub fn find_by_type(&self, widget_type: &str) -> Vec<&WidgetAnnotation>

Finds annotations by widget type name.

pub fn find_by_id(&self, id: &str) -> Option<&WidgetAnnotation>

Finds an annotation by its id.

pub fn focused_annotations(&self) -> Vec<&WidgetAnnotation>

Returns all focused annotations.

pub fn to_json(&self) -> Option<String>

Serializes the output to a JSON string.

Returns None if serialization fails.

pub fn to_json_pretty(&self) -> Option<String>

Serializes the output to a pretty-printed JSON string.

Returns None if serialization fails.

Trait Implementations

impl Clone for AnnotatedOutput

fn clone(&self) -> AnnotatedOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotatedOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnnotatedOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AnnotatedOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.