Struct PageLabelRange 

pub struct PageLabelRange { /* private fields */ }

One labelling rule, and the page it starts at.

use pdfrum_edit::{PageLabelRange, PageLabelStyle};

// Front matter in lower-case roman, then the body restarting at 1.
let front = PageLabelRange::new(0u32, PageLabelStyle::LowerRoman);
let body = PageLabelRange::new(4u32, PageLabelStyle::Decimal).prefix("Part 1-");
assert_eq!(front.start().get(), 0);
assert_eq!(body.start().get(), 4);

Implementations

impl PageLabelRange

pub fn new(start: impl Into<PageIndex>, style: PageLabelStyle) -> Self

A rule that takes effect at start and runs until the next one.

pub fn start(&self) -> PageIndex

The page this rule takes effect at.

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

/P: text placed before the numeric part of every label in the range.

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

/St: the number the first page of the range is labelled with.

Defaults to 1, which is what makes a second range restart rather than continue — the usual reason a document has more than one.

Trait Implementations

impl Clone for PageLabelRange

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 PageLabelRange

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

Formats the value using the given formatter.

impl Eq for PageLabelRange

impl PartialEq for PageLabelRange

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PageLabelRange