Struct Image 

#[non_exhaustive]
pub struct Image {
    pub path: String,
    pub width: HwpUnit,
    pub height: HwpUnit,
    pub format: ImageFormat,
    pub caption: Option<Caption>,
    pub placement: Option<ImagePlacement>,
}

An image reference within the document.

Contains the path to the image resource (relative to the document package root), its display dimensions, and format hint.

No Binary Data

Core deliberately holds no image bytes. The Smithy crate resolves path into actual binary data during encode/decode.

Examples

use hwpforge_core::image::{Image, ImageFormat};
use hwpforge_foundation::HwpUnit;

let img = Image::new(
    "BinData/logo.jpeg",
    HwpUnit::from_mm(80.0).unwrap(),
    HwpUnit::from_mm(40.0).unwrap(),
    ImageFormat::Jpeg,
);
assert_eq!(img.format, ImageFormat::Jpeg);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: String

Relative path within the document package (e.g. "BinData/image1.png").

width: HwpUnit

Display width.

height: HwpUnit

Display height.

format: ImageFormat

Image format hint.

caption: Option<Caption>

Optional image caption.

placement: Option<ImagePlacement>

Optional placement/presentation metadata.

Implementations

impl Image

pub fn new( path: impl Into<String>, width: HwpUnit, height: HwpUnit, format: ImageFormat, ) -> Self

Creates a new image reference.

Examples

use hwpforge_core::image::{Image, ImageFormat};
use hwpforge_foundation::HwpUnit;

let img = Image::new(
    "images/photo.png",
    HwpUnit::from_mm(100.0).unwrap(),
    HwpUnit::from_mm(75.0).unwrap(),
    ImageFormat::Png,
);
assert_eq!(img.path, "images/photo.png");

pub fn from_path( path: impl Into<String>, width: HwpUnit, height: HwpUnit, ) -> Self

Creates an image reference by inferring the format from the file extension.

The extension is case-insensitive. Unrecognized extensions produce ImageFormat::Unknown containing the lowercase extension string.

Examples

use hwpforge_core::image::{Image, ImageFormat};
use hwpforge_foundation::HwpUnit;

let w = HwpUnit::from_mm(100.0).unwrap();
let h = HwpUnit::from_mm(75.0).unwrap();

let img = Image::from_path("photos/hero.png", w, h);
assert_eq!(img.format, ImageFormat::Png);

let img_jpg = Image::from_path("scan.JPG", w, h);
assert_eq!(img_jpg.format, ImageFormat::Jpeg);

let img_unknown = Image::from_path("diagram.svg", w, h);
assert_eq!(img_unknown.format, ImageFormat::Unknown("svg".to_string()));

pub fn with_caption(self, caption: Caption) -> Self

Attaches a caption to the image.

pub fn with_placement(self, placement: ImagePlacement) -> Self

Attaches placement metadata while preserving the existing constructor API.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Image

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Image

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

Formats the value using the given formatter.

impl JsonSchema for Image

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 Image

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Image

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 Image