Struct Annotation 

pub struct Annotation {
    pub start_byte: usize,
    pub end_byte: usize,
    pub category: HighlightCategory,
}

A single annotation on a buffer range.

Annotations are the unified representation for all semantic markup: syntax highlights, decorations, diagnostics, search matches, etc.

The server emits only byte ranges and categories (mechanism). Clients decide how to render each category (policy).

Example

use reovim_driver_syntax::{Annotation, HighlightCategory};

let ann = Annotation::new(0, 5, HighlightCategory::new("keyword.function"));
assert_eq!(ann.category.as_str(), "keyword.function");
assert_eq!(ann.len(), 5);

Fields

start_byte: usize

Start byte offset (inclusive).

end_byte: usize

End byte offset (exclusive).

category: HighlightCategory

Category string (e.g., “keyword.function”, “markup.heading.1”).

Implementations

impl Annotation

pub const fn new( start_byte: usize, end_byte: usize, category: HighlightCategory, ) -> Self

Create an annotation.

pub const fn len(&self) -> usize

Get the length in bytes.

pub const fn is_empty(&self) -> bool

Check if the annotation is empty.

pub const fn overlaps(&self, range: &Range<usize>) -> bool

Check if this annotation overlaps with a byte range.

pub const fn contains(&self, byte: usize) -> bool

Check if this annotation contains a byte offset.

pub const fn byte_range(&self) -> Range<usize>

Get this annotation as a byte range.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl PartialEq for Annotation

fn eq(&self, other: &Annotation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Annotation

impl StructuralPartialEq for Annotation