Struct Image 

pub struct Image {
    pub file_ref: FileRef,
    pub width: Option<u32>,
    pub height: Option<u32>,
    pub alt_text: Option<String>,
    pub caption: Option<String>,
    pub format: Option<String>,
    pub metadata: Vec<Metadata>,
}

Image reference with metadata

Contains a file reference to an image along with image-specific metadata such as dimensions, format, and other properties useful for displaying images.

Fields

file_ref: FileRef

Reference to the stored image file

width: Option<u32>

Image width in pixels (if known)

height: Option<u32>

Image height in pixels (if known)

alt_text: Option<String>

Alternative text for accessibility

caption: Option<String>

Human-readable caption or description

format: Option<String>

Image format (e.g., “PNG”, “JPEG”, “WEBP”) This may differ from content_type in the FileRef as it’s more specific to images

metadata: Vec<Metadata>

Additional image-specific metadata using structured types

Implementations

impl Image

pub fn new(file_ref: FileRef) -> Image

Create a new Image with just a file reference

pub fn with_dimensions(self, width: u32, height: u32) -> Image

Set image dimensions

pub fn with_alt_text(self, alt_text: String) -> Image

Set alternative text for accessibility

pub fn with_caption(self, caption: String) -> Image

Set image caption or description

pub fn with_format(self, format: String) -> Image

Set image format

pub fn with_metadata(self, key: String, value: String) -> Image

Add generic metadata to the image

pub fn with_structured_metadata(self, metadata: Metadata) -> Image

Add structured metadata to the image

pub fn generic_metadata(&self) -> BTreeMap<String, String>

Get all generic metadata as a key-value map for backward compatibility

This method extracts only the Metadata::Generic(key, value) entries and returns them as a BTreeMap<String, String> for backward compatibility with APIs that expect key-value metadata.

pub fn aspect_ratio(&self) -> Option<f32>

Get the aspect ratio (width/height) if dimensions are available

pub fn is_square(&self) -> Option<bool>

Check if this is a square image

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Image, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Image

impl StructuralPartialEq for Image