Struct Pdf

pub struct Pdf { /* private fields */ }

A PDF file.

Implementations

impl Pdf

pub fn new(data: PdfData) -> Result<Self, LoadPdfError>

Try to read the given PDF file.

Returns None if it was unable to read it.

Examples found in repository

examples/iterate.rs (line 18)

fn main() {
    // First load the data that constitutes the PDF file.
    let data = std::fs::read(
        PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../hayro-tests/pdfs/text_with_rise.pdf"),
    )
    .unwrap();

    // Then create a new PDF file from it.
    //
    // Here we are just unwrapping in case reading the file failed, but you
    // might instead want to apply proper error handling.
    let pdf = Pdf::new(Arc::new(data)).unwrap();

    // First access all pages, and then iterate over the operators of each page's
    // content stream and print them.
    let pages = pdf.pages();
    for page in pages.iter() {
        for op in page.typed_operations() {
            println!("{op:?}");
        }
    }
}

pub fn len(&self) -> usize

Return the number of objects present in the PDF file.

pub fn objects(&self) -> impl IntoIterator<Item = Object<'_>>

Return an iterator over all objects defined in the PDF file.

pub fn version(&self) -> PdfVersion

Return the version of the PDF file.

pub fn data(&self) -> &PdfData

Return the underlying data of the PDF file.

pub fn pages(&self) -> &Pages<'_>

Return the pages of the PDF file.

Examples found in repository

examples/iterate.rs (line 22)

fn main() {
    // First load the data that constitutes the PDF file.
    let data = std::fs::read(
        PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../hayro-tests/pdfs/text_with_rise.pdf"),
    )
    .unwrap();

    // Then create a new PDF file from it.
    //
    // Here we are just unwrapping in case reading the file failed, but you
    // might instead want to apply proper error handling.
    let pdf = Pdf::new(Arc::new(data)).unwrap();

    // First access all pages, and then iterate over the operators of each page's
    // content stream and print them.
    let pages = pdf.pages();
    for page in pages.iter() {
        for op in page.typed_operations() {
            println!("{op:?}");
        }
    }
}

pub fn xref(&self) -> &XRef

Return the xref of the PDF file.