peasy-compress

Async Rust client for the Peasy Compress API — ZIP, TAR, gzip, and brotli compression and extraction. Built with reqwest, serde, and tokio.

Built from Peasy Tools, a free online toolkit with compression tools for creating and extracting ZIP, TAR, gzip, and brotli archives.

Try the interactive tools at peasytools.com — Compression Tools, Glossary, Guides

Install

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

Or via cargo:

cargo add peasy-compress

Quick Start

use peasy_compress::Client;

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

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

    Ok(())
}

API Client

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

use peasy_compress::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_compress::ListOptions {
        page: Some(1),
        limit: Some(10),
        search: Some("zip".into()),
        ..Default::default()
    };
    let tools = client.list_tools(&opts).await?;

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

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

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

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

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

    Ok(())
}

Available Methods

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

Learn More

• Tools: ZIP Compress · TAR Archive · All Tools
• Guides: How to Compress Files · All Guides
• Glossary: What is Gzip? · All Terms
• Formats: ZIP · All Formats
• API: REST API Docs · OpenAPI Spec

Also Available

Peasy Developer Tools

Part of the Peasy Tools open-source developer ecosystem.

License

MIT