Enum ImageFormat 

#[non_exhaustive]
pub enum ImageFormat {
    Png,
    Jpeg,
    Gif,
    Bmp,
    Wmf,
    Emf,
    Unknown(String),
}

Supported image formats.

Marked #[non_exhaustive] so new formats can be added in future phases without a breaking change.

Examples

use hwpforge_core::image::ImageFormat;

let fmt = ImageFormat::Png;
assert_eq!(fmt.to_string(), "PNG");

let unknown = ImageFormat::Unknown("SVG".to_string());
assert_eq!(unknown.to_string(), "svg");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Png

Portable Network Graphics.

Jpeg

JPEG.

Gif

Graphics Interchange Format.

Bmp

Windows Bitmap.

Wmf

Windows Metafile.

Emf

Enhanced Metafile.

Unknown(String)

Unrecognized format with its extension or MIME type.

Implementations

impl ImageFormat

pub fn from_extension(path: &str) -> Self

Infers an ImageFormat from a file path’s extension.

The extension is extracted from everything after the last '.' in the path string and matched case-insensitively. If no dot is found, or the extension is not recognized, ImageFormat::Unknown is returned containing the lowercase extension (or an empty string when absent).

Examples

use hwpforge_core::image::ImageFormat;

assert_eq!(ImageFormat::from_extension("photo.png"),  ImageFormat::Png);
assert_eq!(ImageFormat::from_extension("image.JPG"),  ImageFormat::Jpeg);
assert_eq!(ImageFormat::from_extension("file.jpeg"), ImageFormat::Jpeg);
assert_eq!(ImageFormat::from_extension("doc.gif"),   ImageFormat::Gif);
assert_eq!(ImageFormat::from_extension("img.bmp"),   ImageFormat::Bmp);
assert_eq!(ImageFormat::from_extension("chart.wmf"), ImageFormat::Wmf);
assert_eq!(ImageFormat::from_extension("dia.emf"),   ImageFormat::Emf);
assert_eq!(
    ImageFormat::from_extension("file.xyz"),
    ImageFormat::Unknown("xyz".to_string()),
);
assert_eq!(
    ImageFormat::from_extension("noext"),
    ImageFormat::Unknown(String::new()),
);
assert_eq!(ImageFormat::from_extension("multi.dot.png"), ImageFormat::Png);

pub fn sniff(bytes: &[u8]) -> Option<Self>

Sniffs an ImageFormat from the leading magic bytes.

Extension-derived formats (Self::from_extension) are diagnostic hints only — file names cannot be trusted. Byte sniffing is the ground truth for admission decisions (e.g. the Markdown → HWPX image embed loader only packages bytes whose magic identifies a format HWPX BinData natively carries).

Returns None for empty, truncated, or unrecognized bytes — callers must not guess from content. Magic table (shares the render-side sniffer’s rules in smithy-pdf, with two deliberate divergences for ingestion, W6 §12b·§12-r2):

• PNG 89 50 4E 47 0D 0A 1A 0A · JPEG FF D8 FF · GIF GIF87a/GIF89a
• BMP BM plus structural header checks — bfOffBits (offset 10) within 14..=len and a known DIB header size (offset 14 ∈ {12, 40, 52, 56, 64, 108, 124}). The 2-byte magic alone admits arbitrary bytes starting with BM into packages (ingestion is stricter than the render sniffer, which only gates an error path).
• EMF record type 01 00 00 00 + " EMF" signature at offset 40
• WMF placeable only (D7 CD C6 9A) — standard WMF’s magic is too weak and would misfire, so it stays unrecognized
• WebP is intentionally absent (render sniffer knows it): HWPX BinData carry of WebP is unverified against Hancom, so ingestion refuses it until a native fixture proves it (§12-r2).

Examples

use hwpforge_core::image::ImageFormat;

let png = [0x89, b'P', b'N', b'G', 0x0D, 0x0A, 0x1A, 0x0A, 0, 0];
assert_eq!(ImageFormat::sniff(&png), Some(ImageFormat::Png));
assert_eq!(ImageFormat::sniff(b"GIF89a\x00"), Some(ImageFormat::Gif));
assert_eq!(ImageFormat::sniff(b"not an image"), None);
assert_eq!(ImageFormat::sniff(&[]), None);

pub fn canonical_extension(&self) -> Option<&'static str>

Canonical file extension for a sniffed format (used to build synthetic package keys like image1.png).

Returns None for Self::Unknown — unknown formats never get a synthetic key (they are not admitted into packages).

Examples

use hwpforge_core::image::ImageFormat;

assert_eq!(ImageFormat::Jpeg.canonical_extension(), Some("jpg"));
assert_eq!(ImageFormat::Unknown("svg".into()).canonical_extension(), None);

Trait Implementations

impl Clone for ImageFormat

fn clone(&self) -> ImageFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ImageFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ImageFormat

impl Hash for ImageFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for ImageFormat

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ImageFormat

fn eq(&self, other: &ImageFormat) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ImageFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ImageFormat