Struct AnnotationBuilder 

pub struct AnnotationBuilder { /* private fields */ }

Incrementally constructs document annotations while interning stream names.

Implementations

impl AnnotationBuilder

pub fn new() -> Self

Create an empty annotation builder.

pub fn stream(&mut self, stream: impl Into<String>) -> StreamHandle

Intern a source stream name and return its reusable handle.

pub fn note( &mut self, id: impl Display, stream: StreamHandle, offset: u64, ) -> ProvenanceNote<'_>

Record an entity’s source location.

The returned value supports the ergonomic builder.note(&id, stream, offset).tag("face") form.

pub fn exactness(&mut self, id: impl Display, exactness: Exactness) -> &mut Self

Set entity-level exactness. Byte-exact entries are removed to preserve the table’s sparse absent-means-byte-exact representation.

pub fn derived( &mut self, id: impl Display, field: impl Into<String>, ) -> &mut Self

Mark one serialized field as deterministically derived.

pub fn field_exactness( &mut self, id: impl Display, field: impl Into<String>, exactness: Exactness, ) -> &mut Self

Set a serialized field’s exactness.

A byte-exact override is omitted because it is already the sparse default. Empty byte-exact notes are removed.

pub fn remove_entity(&mut self, id: impl Display)

Remove all annotations for an entity that was removed from the model.

pub fn annotations(&self) -> &Annotations

Borrow the annotations built so far.

pub fn build(self) -> Annotations

Finish building and return the annotation tables.

Trait Implementations

impl Clone for AnnotationBuilder

fn clone(&self) -> AnnotationBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationBuilder

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

Formats the value using the given formatter.

impl Default for AnnotationBuilder

fn default() -> AnnotationBuilder

Returns the “default value” for a type.