img4avif 0.7.0

Serverless-optimized image conversion: JPEG/PNG/WebP/HEIC → AVIF with HDR10 input support (pure Rust, Lambda-ready)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

use thiserror::Error;

/// All errors that can be returned by `img4avif`.
///
/// This enum is `#[non_exhaustive]`: match it with a wildcard arm (`_`) so
/// that your code continues to compile when new variants are added in future
/// minor versions.
///
/// # Example
///
/// ```rust,no_run
/// # use img4avif::{Config, Converter, Error};
/// # let input = vec![];
/// # let converter = Converter::new(Config::default()).unwrap();
/// match converter.convert(&input) {
///     Ok(avif) => println!("encoded {} bytes", avif.len()),
///     Err(Error::InputTooLarge { width, height, .. }) => {
///         eprintln!("image {width}×{height} is too large");
///     }
///     Err(e) => eprintln!("conversion failed: {e}"),
/// }
/// ```
#[non_exhaustive]
#[derive(Debug, Error)]
pub enum Error {
    /// The input bytes could not be decoded as a recognised image format.
    #[error("failed to decode image: {0}")]
    Decode(String),

    /// AVIF encoding failed.
    #[error("failed to encode AVIF: {0}")]
    Encode(String),

    /// The image dimensions exceed the configured [`crate::Config::max_pixels`] limit.
    #[error(
        "input too large: {width}×{height} ({} pixels) exceeds the {max_pixels}-pixel limit",
        u64::from(*width) * u64::from(*height)
    )]
    InputTooLarge {
        /// Image width in pixels.
        width: u32,
        /// Image height in pixels.
        height: u32,
        /// The configured pixel limit.
        max_pixels: u64,
    },

    /// Peak RSS memory exceeded [`crate::Config::memory_limit_bytes`].
    ///
    /// Return this error immediately without further processing.
    #[error("memory limit met or exceeded: {used_mb} MB increase, limit is {limit_mb} MB")]
    MemoryExceeded {
        /// RSS increase in megabytes observed since the guard was created.
        used_mb: u64,
        /// Configured limit in megabytes.
        limit_mb: u64,
    },

    /// An I/O error occurred.
    ///
    /// Implementing `From<std::io::Error>` allows callers to use `?` on I/O
    /// operations when building on top of this library.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// The requested format requires an optional feature flag that was not
    /// enabled at compile time.
    ///
    /// Enable the `heic-experimental` or `raw-experimental` feature to add
    /// support for those formats.
    #[error(
        "format not supported in this build: {0} \
         (enable the corresponding Cargo feature flag)"
    )]
    UnsupportedFormat(String),

    /// An unexpected internal error occurred.
    ///
    /// Please [file a bug report] if you see this variant in production.
    ///
    /// [file a bug report]: https://github.com/Canter-Equine/img4avif/issues
    #[error("internal error: {0}")]
    Internal(String),
}