Struct DocumentComments 

pub struct DocumentComments(/* private fields */);

Every comment thread supplied to one export, keyed by DocumentComment::uid.

A BTreeMap, not a HashMap, for the same reason super::image_options::ExportImages is one: two exports of the same document must be byte-comparable, and a randomised iteration order would quietly break that. Keying by uid rather than storing a bare Vec also makes “does this document already carry a thread with this id” an O(log n) lookup instead of a linear scan — relevant because a caller re-exporting after an edit typically hands over its whole current comment set again, not just what changed since last time.

Iteration order is uid order, which is not the order a writer needs to open and close ranges in as it walks the document front to back — use in_document_order for that.

Implementations

impl DocumentComments

pub fn new() -> DocumentComments

pub fn insert(&mut self, comment: DocumentComment) -> &mut DocumentComments

Register a comment, keyed by its own uid. A second insert under the same uid replaces the first — the caller is expected to hand over its current state on every export, not maintain an append-only log through this type.

pub fn get(&self, uid: &str) -> Option<&DocumentComment>

pub fn iter(&self) -> impl Iterator<Item = &DocumentComment>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn in_document_order(&self) -> Vec<&DocumentComment>

Every comment, sorted by (start, end, uid) — the order a writer walking the document text front-to-back needs to open and close ranges in. uid breaks an exact (start, end) tie deterministically (two threads anchored to the identical span) rather than leaving it to whatever order the BTreeMap’s own key (uid again, but unsorted by position) happened to produce.

Trait Implementations

impl Clone for DocumentComments

fn clone(&self) -> DocumentComments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentComments

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

Formats the value using the given formatter.

impl Default for DocumentComments

fn default() -> DocumentComments

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentComments

fn deserialize<__D>( __deserializer: __D, ) -> Result<DocumentComments, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentComments

impl FromIterator<DocumentComment> for DocumentComments

fn from_iter<I>(iter: I) -> DocumentComments

where I: IntoIterator<Item = DocumentComment>,

Creates a value from an iterator.

impl PartialEq for DocumentComments

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocumentComments

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocumentComments