Struct PageRange 

pub struct PageRange(/* private fields */);

A parsed page range: zero-based page indices, in the order named, with duplicates kept.

Implementations

impl PageRange

pub fn all(count: u32) -> Self

Every page of a document of count pages, in order.

pub fn of(indices: impl IntoIterator<Item = impl Into<PageIndex>>) -> Self

A range naming exactly these zero-based indices.

pub fn parse(text: &str, count: u32) -> Result<Self, Error>

Parse "1,3-5" against a document of count pages.

Numbers in the text are one-based; the indices returned are zero-based.

Errors

Error::BadPageRange for anything the grammar rejects — an illegal character, a page number outside 1..=count, a descending range, a three-part entry, or an empty entry. One bad entry fails the whole string.

use pdfrum_edit::PageRange;

let range = PageRange::parse("1,3-5", 10)?;
assert_eq!(range.indices().iter().map(|p| p.get()).collect::<Vec<_>>(), [0, 2, 3, 4]);
// Order is preserved and duplicates are kept.
let dupes = PageRange::parse("2,1,1", 10)?;
assert_eq!(dupes.indices().iter().map(|p| p.get()).collect::<Vec<_>>(), [1, 0, 0]);
// One bad entry discards everything.
assert!(PageRange::parse("1,clams", 10).is_err());

pub fn indices(&self) -> &[PageIndex]

The zero-based indices, in the order named.

pub fn len(&self) -> usize

How many pages the range names, duplicates counted.

pub fn is_empty(&self) -> bool

Whether the range names no pages.

Trait Implementations

impl Clone for PageRange

fn clone(&self) -> PageRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageRange

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

Formats the value using the given formatter.

impl Default for PageRange

fn default() -> PageRange

Returns the “default value” for a type.

impl Eq for PageRange

impl PartialEq for PageRange

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PageRange