Struct BookmarkSpec 

pub struct BookmarkSpec {
    pub title: String,
    pub depth: usize,
    pub target: BookmarkTarget,
    pub color: Option<(f32, f32, f32)>,
    pub style: Option<i64>,
    pub open: bool,
}

One bookmark, as a caller describes it.

depth is what the reader’s Bookmark::depth answers: zero is a top-level item, and an item deeper than the one before it is that item’s child. A depth that jumps by more than one is clamped to one deeper, since there is no honest tree that shape describes.

Fields

title: String

The visible text, written as /Title.

depth: usize

How deep the item sits; zero is top level.

target: BookmarkTarget

Where it points.

color: Option<(f32, f32, f32)>

/C, the item’s colour as three components in [0, 1].

style: Option<i64>

/F style bits: 1 italic, 2 bold.

open: bool

Whether the item shows its children when the outline opens.

A closed item writes a negative /Count, which is how a reader tells “collapsed” from “has no children”.

Implementations

impl BookmarkSpec

pub fn new(title: impl Into<String>) -> Self

A top-level bookmark pointing nowhere.

pub fn depth(self, depth: usize) -> Self

Sets how deep the item sits; zero is top level.

pub fn page(self, page: ObjRef, view: AnnotGoToView) -> Self

Points the item at a page.

pub fn named(self, name: impl Into<String>) -> Self

Points the item at a name the document already carries.

pub fn color(self, rgb: (f32, f32, f32)) -> Self

Sets /C, the item’s colour.

pub fn style(self, style: i64) -> Self

Sets /F: 1 italic, 2 bold.

pub fn open(self, open: bool) -> Self

Whether the item’s children show when the outline opens.

Trait Implementations

impl Clone for BookmarkSpec

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 BookmarkSpec

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

Formats the value using the given formatter.

impl PartialEq for BookmarkSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BookmarkSpec