Struct DocumentMarks 

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

Every mark supplied to one export, keyed by name.

A BTreeMap for the same reason DocumentComments is one: two exports of the same document must be byte-comparable, and a randomised iteration order would quietly break that. Keying by name also makes the uniqueness the formats require structural — a bookmark name may appear only once in a document, and a Vec would let a caller supply the same name twice and produce a file neither editor can open cleanly.

Implementations

impl DocumentMarks

pub fn new() -> DocumentMarks

pub fn insert(&mut self, mark: DocumentMark) -> &mut DocumentMarks

Register a mark, keyed by its own name. A second insert under the same name replaces the first.

pub fn get(&self, name: &str) -> Option<&DocumentMark>

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

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

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

Every mark, sorted by (start, end, name) — the order a writer walking the document front-to-back opens and closes them in. name breaks an exact positional tie deterministically.

pub fn validate(&self) -> Result<(), String>

Validate every mark, reporting all the problems rather than the first — a caller fixing a name-generation bug wants the whole list, not one round trip per offender.

Trait Implementations

impl Clone for DocumentMarks

fn clone(&self) -> DocumentMarks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMarks

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

Formats the value using the given formatter.

impl Default for DocumentMarks

fn default() -> DocumentMarks

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentMarks

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentMarks

impl PartialEq for DocumentMarks

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocumentMarks

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 DocumentMarks