sic_core 0.23.0

Common types and re-exports for the 'imagineer' image cli project
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

//! The primary definition of an animated image.

use crate::errors::SicCoreError;
use image::{DynamicImage, Frames};
use std::fmt::{Debug, Formatter};

#[derive(Clone)]
pub struct AnimatedImage {
    frames: Vec<image::Frame>,
}

impl AnimatedImage {
    /// Consume a collection of frames to produce an `AnimatedImage`
    pub fn from_frames(frames: impl IntoIterator<Item = image::Frame>) -> Self {
        Self {
            frames: frames.into_iter().collect(),
        }
    }

    /// Returns the selected frame from the animated image as static image
    pub fn try_into_static_image(self, index: usize) -> Result<DynamicImage, SicCoreError> {
        let frames = self.frames.len();

        self.frames
            .into_iter()
            .nth(index)
            .map(|frame| DynamicImage::ImageRgba8(frame.into_buffer()))
            .ok_or(SicCoreError::InvalidFrameIndex { index, len: frames })
    }

    /// Returns a slice of image Frames
    pub fn frames(&self) -> &[image::Frame] {
        &self.frames
    }

    /// Returns a mutable slice of image frames
    pub fn frames_mut(&mut self) -> &mut [image::Frame] {
        &mut self.frames
    }

    /// Collects and returns an owned collection of image frames
    pub fn collect_frames(&self) -> Vec<image::Frame> {
        self.frames.clone()
    }
}

impl<'frames> TryFrom<Frames<'frames>> for AnimatedImage {
    type Error = SicCoreError;

    fn try_from(item: Frames<'frames>) -> Result<Self, Self::Error> {
        let frames = item.collect_frames().map_err(SicCoreError::ImageError)?;

        Ok(Self { frames })
    }
}

impl Debug for AnimatedImage {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_fmt(format_args!(
            "AnimatedImage(frame_count={})",
            self.frames.len()
        ))
    }
}