imgii 0.8.0

ASCII Image Generator
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

//! Contains helpers for handling supported output image types.

/// Holds the image types that imgii can output.
/// Each value holds an index into the `IMAGE_STR_TYPES` array.
#[derive(Debug, Clone, Copy)]
pub enum OutputImageType {
    Png,
    Gif,
}

// image type string defines
const IMG_TYPE_PNG: &str = ".png";
const IMG_TYPE_GIF: &str = ".gif";

/// All image types stored in an array, for iterating through all image types.
pub const IMG_TYPES_ARRAY: &[&str] = &[IMG_TYPE_PNG, IMG_TYPE_GIF];

impl OutputImageType {
    /// Converts a string slice to an `OutputImageType`.
    ///
    /// * `output_image_type_str`:
    fn from_str(output_image_type_str: &str) -> Option<Self> {
        match output_image_type_str {
            IMG_TYPE_PNG => Some(OutputImageType::Png),
            IMG_TYPE_GIF => Some(OutputImageType::Gif),
            _ => None,
        }
    }

    /// Converts this file name to an `OutputImageType`.
    ///
    /// * `file_name`: The file name to check the file extension of.
    pub fn from_file_name(file_name: &str) -> Option<Self> {
        // find where the file extension starts (last "." in the string)
        let file_extension_start_idx = file_name.rfind(".");
        match file_extension_start_idx {
            Some(file_extension_start_idx) => {
                // match the string, starting from the last "."
                // see if this file extension matches any of the file extension strings we have
                Self::from_str(&file_name[file_extension_start_idx..])
            }
            None => None,
        }
    }

    /// Converts to this type's file extension.
    pub fn as_file_extension(&self) -> &'static str {
        match *self {
            OutputImageType::Png => IMG_TYPE_PNG,
            OutputImageType::Gif => IMG_TYPE_GIF,
        }
    }
}

/// Holds whether the program should convert a batch of inputs or just a single.
#[derive(Debug, Clone)]
pub enum ImageBatchType {
    Single,
    /// Contains the final image index for this batch.
    Batch {
        final_index: u32,
    },
}