Welcome to the Zstandard Flutter plugin documentation. This directory contains comprehensive guides, API references, and development documentation for the zstandard compression ecosystem.
- Overview — High-level architecture and federated plugin design
- Platform Interface — Interface contract and platform abstraction
- FFI Implementation — Native FFI pattern for mobile and desktop
- Web Implementation — WebAssembly and JS interop approach
- Isolate Pattern — Async compression with isolates
- Performance — Benchmarks and optimization techniques
- Main API — Zstandard class and public API
- Extensions — ZstandardExt extension methods
- Platform Interface API — Platform contract reference
- CLI API — zstandard_cli package API
- Getting Started — Quick start guide
- Installation — Platform-specific setup
- Usage Examples — Real-world examples
- Compression Levels — Performance vs ratio guide
- Error Handling — Error scenarios and recovery
- Security — Input validation and handling untrusted data
- Advanced Usage — Large files, chunking, and memory optimization
- Best Practices — Production checklist and anti-patterns
- Performance Tips — Optimization guide
- Migration Guide — Version migration
- Contributing — Contribution guidelines
- Setup — Development environment
- Building — Build instructions
- Testing — Testing guidelines
- Code Style — Coding standards
- CI/CD — GitHub Actions and automation
- Release Process — Release workflow
-
Common Issues — FAQ and solutions
-
Platform Issues — Platform-specific issues
-
Debugging — Debug techniques
-
Glossary — Terms and acronyms
| Package | Description |
|---|---|
| zstandard | Main Flutter plugin for cross-platform compression |
| zstandard_cli | Pure Dart CLI for macOS, Windows, and Linux |
| zstandard_platform_interface | Platform interface contract |
| zstandard_native | Shared C source (facebook/zstd) and FFI bindings; used by all native platforms and CLI |
| zstandard_android, zstandard_ios, zstandard_macos | Mobile and macOS implementations |
| zstandard_linux, zstandard_windows | Desktop implementations |
| zstandard_web | Web (WebAssembly) implementation |