Skip to main content

Bookmark

Struct Bookmark 

Source
pub struct Bookmark { /* private fields */ }
Expand description

A PDF bookmark (outline item).

Implementations§

Source§

impl Bookmark

Source

pub fn load(obj_num: u32, doc: &mut CosDoc) -> Result<Self>

Load a bookmark from a document.

Source

pub fn title(&self) -> &str

Get the bookmark title.

Source

pub fn id(&self) -> ObjectId

Get the object ID.

Source

pub fn is_open(&self) -> bool

Whether this bookmark is open (children visible).

Source

pub fn is_italic(&self) -> bool

Whether this bookmark is italic.

Source

pub fn is_bold(&self) -> bool

Whether this bookmark is bold.

Source

pub fn color(&self) -> Option<[f64; 3]>

Get the bookmark color (RGB).

Source

pub fn destination(&self) -> Option<&PdfObject>

Get the destination object (if any).

Source

pub fn action(&self) -> Option<&PdfObject>

Get the action object (if any).

Source

pub fn first_child(&self) -> Option<ObjectId>

Get the first child bookmark ID.

Source

pub fn next(&self) -> Option<ObjectId>

Get the next sibling bookmark ID.

Source

pub fn prev(&self) -> Option<ObjectId>

Get the previous sibling bookmark ID.

Source

pub fn parent(&self) -> Option<ObjectId>

Get the parent bookmark ID.

Source

pub fn has_children(&self) -> bool

Check if this bookmark has children.

Source

pub fn get_all(doc: &mut CosDoc) -> Result<Vec<(Bookmark, u32)>>

Get all bookmarks in the document as a flat list (depth-first).

Trait Implementations§

Source§

impl Clone for Bookmark

Source§

fn clone(&self) -> Bookmark

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Bookmark

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.