peasy-pdf

Async Rust client for the PeasyPDF API — merge, split, rotate, and compress PDF files. Built with reqwest, serde, and tokio.

Built from PeasyPDF, a comprehensive PDF toolkit offering free online tools for merging, splitting, rotating, compressing, and converting PDF documents. The site includes detailed guides on PDF optimization, accessibility best practices, and format conversion, plus a glossary covering terms from linearization to OCR to PDF/A archival compliance.

Try the interactive tools at peasypdf.com — Merge PDF, Split PDF, Compress PDF, Rotate PDF, and more.

Table of Contents

• Install
• Quick Start
• What You Can Do
  • PDF Document Operations
  • Browse Reference Content
  • Search and Discovery
• API Client
  • Available Methods
• Learn More About PDF Tools
• Also Available
• Peasy Developer Tools
• License

Install

[dependencies]
peasy-pdf = "0.2.0"
tokio = { version = "1", features = ["full"] }

Or via cargo:

cargo add peasy-pdf

Quick Start

use peasy_pdf::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    // List available PDF tools
    let tools = client.list_tools(&Default::default()).await?;
    for tool in &tools.results {
        println!("{}: {}", tool.name, tool.description);
    }

    Ok(())
}

What You Can Do

PDF Document Operations

The Portable Document Format (PDF) was created by Adobe in 1993 and became an open ISO standard (ISO 32000) in 2008. Today PDF is the most widely used format for document exchange, supporting text, images, forms, digital signatures, and embedded multimedia. PeasyPDF provides tools for every common PDF workflow — from merging invoices into a single file to compressing scanned documents for email delivery.

use peasy_pdf::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    // Retrieve the PDF merge tool and inspect its capabilities
    let tool = client.get_tool("pdf-merge").await?;
    println!("Tool: {}", tool.name);              // PDF merge tool name
    println!("Description: {}", tool.description); // How merging works

    // List all available PDF tools with pagination
    let opts = peasy_pdf::ListOptions {
        page: Some(1),
        limit: Some(20),
        ..Default::default()
    };
    let tools = client.list_tools(&opts).await?;
    println!("Total PDF tools available: {}", tools.count);

    Ok(())
}

Learn more: Merge PDF Tool · How to Merge PDF Files · PDF Compression Guide

Browse Reference Content

PeasyPDF includes a comprehensive glossary of document format terminology and in-depth guides for common workflows. The glossary covers foundational concepts like PDF linearization (web-optimized PDFs that load page-by-page), OCR (optical character recognition for scanned documents), DPI (dots per inch for print-quality output), and PDF/A (the ISO 19005 archival standard used by governments and libraries worldwide).

use peasy_pdf::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    // Browse the PDF glossary for document format terminology
    let glossary = client.list_glossary(&peasy_pdf::ListOptions {
        search: Some("linearization".into()), // Search for web-optimized PDF concepts
        ..Default::default()
    }).await?;
    for term in &glossary.results {
        println!("{}: {}", term.term, term.definition);
    }

    // Read a specific guide on PDF accessibility best practices
    let guide = client.get_guide("accessible-pdf-best-practices").await?;
    println!("Guide: {} (Level: {})", guide.title, guide.audience_level);

    Ok(())
}

Learn more: PDF Glossary · Accessible PDF Best Practices · How to Convert PDF to Images

Search and Discovery

The API supports full-text search across all content types — tools, glossary terms, guides, use cases, and format documentation. Search results are grouped by content type, making it easy to find exactly what you need for a specific PDF workflow.

use peasy_pdf::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    // Search across all PDF content — tools, glossary, guides, and formats
    let results = client.search("compress pdf", Some(20)).await?;
    println!("Found {} tools, {} glossary terms, {} guides",
        results.results.tools.len(),
        results.results.glossary.len(),
        results.results.guides.len(),
    );

    // Discover format conversion paths — what can PDF convert to?
    let conversions = client.list_conversions(&peasy_pdf::ListConversionsOptions {
        source: Some("pdf".into()), // Find all formats PDF can be converted to
        ..Default::default()
    }).await?;
    for c in &conversions.results {
        println!("{} -> {}", c.source_format, c.target_format);
    }

    Ok(())
}

Learn more: REST API Docs · All PDF Tools

API Client

The client wraps the PeasyPDF REST API with strongly-typed Rust structs using serde deserialization.

use peasy_pdf::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    // Or with a custom base URL:
    // let client = Client::with_base_url("https://custom.example.com");

    // List tools with filters
    let opts = peasy_pdf::ListOptions {
        page: Some(1),
        limit: Some(10),
        search: Some("compress".into()),
        ..Default::default()
    };
    let tools = client.list_tools(&opts).await?;

    // Get a specific tool
    let tool = client.get_tool("pdf-merge").await?;
    println!("{}: {}", tool.name, tool.description);

    // Search across all content
    let results = client.search("compress", Some(20)).await?;
    println!("Found {} tools", results.results.tools.len());

    // Browse the glossary
    let glossary = client.list_glossary(&peasy_pdf::ListOptions {
        search: Some("pdf-a".into()),
        ..Default::default()
    }).await?;
    for term in &glossary.results {
        println!("{}: {}", term.term, term.definition);
    }

    // Discover guides
    let guides = client.list_guides(&peasy_pdf::ListGuidesOptions {
        category: Some("pdf".into()),
        ..Default::default()
    }).await?;
    for guide in &guides.results {
        println!("{} ({})", guide.title, guide.audience_level);
    }

    // List format conversions
    let conversions = client.list_conversions(&peasy_pdf::ListConversionsOptions {
        source: Some("pdf".into()),
        ..Default::default()
    }).await?;

    Ok(())
}

Available Methods

Full API documentation at peasypdf.com/developers/. OpenAPI 3.1.0 spec: peasypdf.com/api/openapi.json.

Learn More About PDF Tools

• Tools: Merge PDF · Split PDF · Compress PDF · Rotate PDF · PDF to PNG · All Tools
• Guides: How to Merge PDF Files · PDF Compression Guide · Accessible PDF Best Practices · How to Convert PDF to Images · All Guides
• Glossary: PDF · PDF/A · DPI · OCR · Rasterization · All Terms
• Formats: All Formats
• API: REST API Docs · OpenAPI Spec

Also Available

Peasy Developer Tools

Part of the Peasy Tools open-source developer ecosystem.

Embed Widget

Embed PeasyPdf widgets on any website with peasy-pdf-embed:

<script src="https://cdn.jsdelivr.net/npm/peasy-pdf-embed@1/dist/embed.min.js"></script>
<div data-peasypdf="entity" data-slug="example"></div>

Zero dependencies · Shadow DOM · 4 themes (light/dark/sepia/auto) · Widget docs

License

MIT