feim 0.25.1

Modular crate for working with images in Rust
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

#[cfg(feature = "fmt-farbfeld")]
pub mod farbfeld;

#[cfg(feature = "fmt-jpeg")]
pub mod jpeg;

#[cfg(feature = "fmt-png")]
pub mod png;

#[cfg(feature = "fmt-webp")]
pub mod webp;

use std::fmt;
use std::str::FromStr;

use crate::color::convert::ConvertInto;
use crate::color::Color;
use crate::specialized::{self, No};

#[macro_export]
macro_rules! impl_format {
    (name: $name:ty, id: $id:expr, magic: $magic:expr $(,)?) => {
        impl $crate::image::Format for $name {
            fn id(&self) -> &'static str {
                $id
            }
            fn magic(&self) -> &'static [u8] {
                $magic
            }
        }
    };
}

pub trait Format {
    /// Should return a format id, such as:
    ///
    /// - feim:ff
    /// - feim:png
    /// - feim:jpeg
    /// - feim:webp
    fn id(&self) -> &'static str;

    /// Returns the magic string situated at the start of the image file.
    fn magic(&self) -> &'static [u8];

    /// Compares the format's magic string against another byte string.
    fn is_valid_magic(&self, magic: &[u8]) -> bool {
        if magic.len() < self.magic().len() {
            return false;
        }
        self.magic()
            .iter()
            .copied()
            .zip(magic.iter().copied())
            .all(|(m, n)| m == n || m == b'?')
    }
}

pub trait Dimensions {
    fn width(&self) -> usize;
    fn height(&self) -> usize;

    fn dimensions(&self) -> (usize, usize) {
        let w = self.width();
        let h = self.height();
        (w, h)
    }
}

pub trait Image<Specialized = No> {
    type Pixel: Color;

    fn color_get(&self, x: usize, y: usize) -> Self::Pixel;
}

pub trait ImageMut<Specialized = No> {
    type Pixel: Color;

    fn color_set<C, ColorSpecialized>(&mut self, x: usize, y: usize, color: C)
    where
        C: ConvertInto<Self::Pixel, ColorSpecialized> + Color;

    fn color_set_generic<C>(&mut self, x: usize, y: usize, color: C)
    where
        C: ConvertInto<Self::Pixel, specialized::No> + Color,
    {
        self.color_set::<_, specialized::No>(x, y, color)
    }

    fn pixel_set(&mut self, x: usize, y: usize, color: Self::Pixel) {
        self.color_set::<_, specialized::For<Self::Pixel>>(x, y, color)
    }
}

#[derive(Debug, Copy, Clone)]
pub enum BuiltInFormat {
    #[cfg(feature = "fmt-farbfeld")]
    Farbfeld,
    #[cfg(feature = "fmt-jpeg")]
    Jpeg,
    #[cfg(feature = "fmt-png")]
    Png,
    #[cfg(feature = "fmt-webp")]
    Webp,
}

impl FromStr for BuiltInFormat {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, ()> {
        match s {
            #[cfg(feature = "fmt-farbfeld")]
            "farbfeld" => Ok(Self::Farbfeld),
            #[cfg(feature = "fmt-jpeg")]
            "jpeg" => Ok(Self::Jpeg),
            #[cfg(feature = "fmt-png")]
            "png" => Ok(Self::Png),
            #[cfg(feature = "fmt-webp")]
            "webp" => Ok(Self::Webp),
            _ => Err(()),
        }
    }
}

impl fmt::Display for BuiltInFormat {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            #[cfg(feature = "fmt-farbfeld")]
            Self::Farbfeld => write!(f, "farbfeld"),
            #[cfg(feature = "fmt-jpeg")]
            Self::Jpeg => write!(f, "jpeg"),
            #[cfg(feature = "fmt-png")]
            Self::Png => write!(f, "png"),
            #[cfg(feature = "fmt-webp")]
            Self::Webp => write!(f, "webp"),
            #[allow(unreachable_patterns)]
            _ => Ok(()),
        }
    }
}

impl BuiltInFormat {
    pub fn get(self) -> &'static dyn Format {
        match self {
            #[cfg(feature = "fmt-farbfeld")]
            BuiltInFormat::Farbfeld => &farbfeld::Farbfeld,

            #[cfg(feature = "fmt-jpeg")]
            BuiltInFormat::Jpeg => &jpeg::Jpeg,

            #[cfg(feature = "fmt-png")]
            BuiltInFormat::Png => &png::Png,

            #[cfg(feature = "fmt-webp")]
            BuiltInFormat::Webp => &webp::Webp,
        }
    }
}

pub fn built_in_formats() -> &'static [(BuiltInFormat, &'static dyn Format)] {
    &[
        #[cfg(feature = "fmt-farbfeld")]
        {
            (BuiltInFormat::Farbfeld, &farbfeld::Farbfeld)
        },
        #[cfg(feature = "fmt-jpeg")]
        {
            (BuiltInFormat::Jpeg, &jpeg::Jpeg)
        },
        #[cfg(feature = "fmt-png")]
        {
            (BuiltInFormat::Png, &png::Png)
        },
        #[cfg(feature = "fmt-webp")]
        {
            (BuiltInFormat::Webp, &webp::Webp)
        },
    ]
}

pub fn built_in_formats_iter() -> impl Iterator<Item = (BuiltInFormat, &'static dyn Format)> {
    built_in_formats().iter().copied()
}