Struct Annotation 

pub struct Annotation<T = ()> { /* private fields */ }

A caller-provided semantic range with arbitrary typed data.

This annotation marks only price in a one-line source:

use lumis_core::annotations::Annotation;

let source = "let total = price;";
let annotation = Annotation::new(12..17, "search-match")?;

assert_eq!(&source[12..17], "price");

When passed in highlighting options, a custom formatter receives AnnotationStart before price and AnnotationEnd after it.

Implementations

impl<T> Annotation<T>

pub fn new( range: impl Into<AnnotationRange>, data: T, ) -> Result<Annotation<T>, AnnotationError>

Creates an annotation for an offset or position range.

An empty range is a point: it marks a position rather than covering text, and a formatter receives AnnotationStart immediately followed by AnnotationEnd there. Line-keyed overlays need this for a blank line, which has nothing to cover but is still somewhere a review comment can land.

Only a reversed range is rejected. Source bounds, position bounds, and UTF-8 character boundaries are checked when the annotation is used to format a specific source.

pub fn range(&self) -> &AnnotationRange

Returns the caller-provided source range.

pub fn data(&self) -> &T

Returns the caller-owned data.

pub fn into_data(self) -> T

Consumes the annotation and returns its caller-owned data.

Trait Implementations

impl<T> Clone for Annotation<T>

where T: Clone,

fn clone(&self) -> Annotation<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Annotation<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Eq for Annotation<T>

where T: Eq,

impl<T> Hash for Annotation<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for Annotation<T>

where T: PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

impl<T> StructuralPartialEq for Annotation<T>

where T: PartialEq,