Struct PdfBookmark 

pub struct PdfBookmark<'a> { /* private fields */ }

A single bookmark in a PdfBookmarks collection.

Implementations

impl<'a> PdfBookmark<'a>

pub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings

Returns the PdfiumLibraryBindings used by this PdfBookmark.

pub fn title(&self) -> Option<String>

Returns the title of this PdfBookmark, if any.

pub fn action(&self) -> Option<PdfAction<'a>>

Returns the PdfAction associated with this PdfBookmark, if any.

The action indicates the behaviour that will occur when the user interacts with the bookmark in a PDF viewer. For most bookmarks, this will be a local navigation action of type PdfActionType::GoToDestinationInSameDocument, but the PDF file format supports a variety of other actions.

pub fn destination(&self) -> Option<PdfDestination<'a>>

Returns the PdfDestination associated with this PdfBookmark, if any.

The destination specifies the page and region, if any, that will be the target of the action behaviour specified by PdfBookmark::action().

pub fn parent(&self) -> Option<PdfBookmark<'a>>

Returns this PdfBookmark object’s direct parent, if available.

pub fn children_len(&self) -> usize

Returns the number of direct children of this PdfBookmark.

pub fn first_child(&self) -> Option<PdfBookmark<'a>>

Returns the first child PdfBookmark of this PdfBookmark, if any.

pub fn next_sibling(&self) -> Option<PdfBookmark<'a>>

Returns the next PdfBookmark at the same tree level as this PdfBookmark, if any.

pub fn iter_siblings(&self) -> PdfBookmarksIterator<'a>

Returns an iterator over all PdfBookmark sibling nodes of this PdfBookmark.

pub fn iter_direct_children(&self) -> PdfBookmarksIterator<'a>

Returns an iterator over all PdfBookmark child nodes of this PdfBookmark. Only direct children of this PdfBookmark will be traversed by the iterator; grandchildren, great-grandchildren, and other descendant nodes will be ignored. To visit all child nodes, including children of children, use PdfBookmark::iter_all_descendants().

pub fn iter_all_descendants(&self) -> PdfBookmarksIterator<'a>

Returns an iterator over all PdfBookmark descendant nodes of this PdfBookmark, including any children of those nodes. To visit only direct children of this PdfBookmark, use PdfBookmark::iter_direct_children().

Trait Implementations

impl<'a> Clone for PdfBookmark<'a>

fn clone(&self) -> PdfBookmark<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Hash for PdfBookmark<'a>

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<'a> PartialEq for PdfBookmark<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for PdfBookmark<'a>