Struct BookmarkRef 

pub struct BookmarkRef { /* private fields */ }

Immutable summary of one correlated bookmark or one reported marker issue.

Implementations

impl BookmarkRef

pub fn id(&self) -> Option<i32>

pub fn name(&self) -> Option<&str>

pub fn range(&self) -> Option<RunRange>

Return the accepted-view half-open range reported by Document::bookmarks.

Its body index is the paragraph ordinal counted recursively through tables and block content controls, which field numbering reads. Self::direct_range reports the direct body child index instead.

pub fn direct_range(&self) -> Option<RunRange>

Return the same range with the direct body child index that RunPosition, Document::add_bookmark and Document::find_content_index use.

It is None when either marker sits in a table cell or a block content control, which have no direct body index. Run indexes are the same accepted-view boundaries as Self::range, which are the RunPosition run indexes that Document::add_bookmark and Document::add_comment take.

pub fn text(&self) -> &str

pub fn issue(&self) -> Option<&str>

Trait Implementations

impl Clone for BookmarkRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BookmarkRef

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

Formats the value using the given formatter.

impl Eq for BookmarkRef

impl PartialEq for BookmarkRef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BookmarkRef