Skip to main content

Crate byteshaver

Crate byteshaver 

Source
Expand description

§Image Converter byteshaver

byteshaver is a command-line utility focusing on converting images into other formats, specifically focusing on support for modern image standards and encoders.

byteshaver simplifies the process of batch converting images, optimizing for both performance and storage efficiency.

The crate is also a library: use job::JobSpec / job::JobHandle with a job::Reporter implementation to run conversions from other software without any terminal output, or call pipeline::run for the simplest entry point. The desktop GUI lives in the separate byteshaver-gui crate (workspace member gui/) and consumes the same job API, so its conversions are byte-identical to the CLI.

Re-exports§

pub use config::ConversionConfig;
pub use config::EncoderConfig;
pub use config::HeifImagePolicy;
pub use job::Capabilities;
pub use job::EncoderInfo;
pub use job::InputSelection;
pub use job::JobEvent;
pub use job::JobHandle;
pub use job::JobSpec;
pub use job::Reporter;
pub use job::RunReport;
pub use job::Session;
pub use job::StopFlag;
pub use metadata::policy::ExifPolicy;
pub use metadata::policy::TagSelector;
pub use pipeline::CollisionPolicy;
pub use pipeline::FileResult;
pub use pipeline::Outcome;
pub use pipeline::RunStats;
pub use pipeline::run;

Modules§

cli
Command-line interface functionality.
config
User-facing configuration types (global + encoder configuration). User-facing configuration types: the global ConversionConfig and the per-target EncoderConfig with their option structs.
converter
Image conversion functionality. Conversion core: encoder implementations behind the ImageEncoder trait; orchestration (pipeline, stats, progress, ctrl+c) lives in crate::pipeline.
format
Image formats supported by the application.
input
Decode layer producing source images from files. Decode layer: turns file paths into SourceImage values.
job
Headless job API: job specs, reporters, capabilities (plan WS7). Headless job API (plan WS7): drives the conversion core from any front-end (CLI, GUI, tests) without stdout, indicatif or signal coupling.
metadata
Metadata containers decoded from input images. Metadata handling: policy, extraction normalization, EXIF resolution/re-serialization, orientation bake-in and container embedding/muxing helpers.
pipeline
Conversion pipeline (naming, collisions, statistics, entry point). Conversion pipeline: file discovery, per-file conversion flow (output naming, overwrite logic, collision detection), statistics and the library entry point run.
utils
Utility functions and helpers.

Structs§

Error
Represents the error type for the application.