Struct PageRange

pub struct PageRange { /* private fields */ }

Represents a set of page ranges, eg "1,3-5,7".

PageRange is designed to handle user input for printing or pagination purposes. It supports single pages, ranges of pages, and combinations of both, expressed in a comma-separated string format (e.g., "1,3-5,7").

Example

use gotenberg_pdf::PageRange;

let range: PageRange = "1,3-5,7".parse().unwrap();
assert!(range.in_range(3)); // true
assert!(!range.in_range(6)); // false

Implementations

impl PageRange

pub fn new(chunks: Vec<PageRangeChunk>) -> Self

Creates a new PageRange from a vector of PageRangeChunk values.

pub fn in_range(&self, page: usize) -> bool

Checks if the given page number is within the page range.

Trait Implementations

impl Clone for PageRange

fn clone(&self) -> PageRange

Returns a copy 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<'de> Deserialize<'de> for PageRange

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PageRange

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

Formats the value using the given formatter.

impl FromStr for PageRange

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for PageRange

fn eq(&self, other: &PageRange) -> 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 Serialize for PageRange

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PageRange

impl StructuralPartialEq for PageRange