Struct ImageAsset 

pub struct ImageAsset {
    pub id: String,
    pub path: String,
    pub hash: DocumentId,
    pub format: ImageFormat,
    pub size: u64,
    pub width: Option<u32>,
    pub height: Option<u32>,
    pub alt: Option<String>,
    pub title: Option<String>,
    pub attribution: Option<String>,
    pub variants: Vec<ImageVariant>,
}

An image asset embedded in a Codex document.

Fields

id: String

Unique identifier for the image.

path: String

Path within the archive (e.g., “assets/images/logo.png”).

hash: DocumentId

Content hash for verification.

format: ImageFormat

Image format.

size: u64

File size in bytes.

width: Option<u32>

Image width in pixels (for raster images).

height: Option<u32>

Image height in pixels (for raster images).

alt: Option<String>

Alternative text for accessibility.

title: Option<String>

Optional title/caption.

attribution: Option<String>

Source attribution or copyright.

variants: Vec<ImageVariant>

Resolution variants for responsive images.

Each variant represents the same image at a different resolution, typically for different screen densities (1x, 2x, 3x).

Implementations

impl ImageAsset

pub fn new(id: impl Into<String>, format: ImageFormat) -> Self

Create a new image asset.

pub fn with_hash(self, hash: DocumentId) -> Self

Set the content hash.

pub const fn with_size(self, size: u64) -> Self

Set the file size.

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

Set the dimensions.

pub fn with_alt(self, alt: impl Into<String>) -> Self

Set the alternative text.

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title.

pub fn with_attribution(self, attribution: impl Into<String>) -> Self

Set the attribution.

pub fn with_path(self, path: impl Into<String>) -> Self

Set a custom path.

pub fn with_variant(self, variant: ImageVariant) -> Self

Add a resolution variant.

pub fn with_variants(self, variants: Vec<ImageVariant>) -> Self

Add multiple resolution variants.

pub fn has_variants(&self) -> bool

Check if this image has resolution variants.

pub fn variant_for_scale(&self, scale: f32) -> Option<&ImageVariant>

Get the variant for a specific scale, if available.

pub fn best_variant_for_width(&self, target_width: u32) -> Option<&ImageVariant>

Get the best variant for a given target width.

Returns the smallest variant that is at least as wide as the target, or the largest available variant if none are wide enough.

Trait Implementations

impl Asset for ImageAsset

fn id(&self) -> &str

Get the asset’s unique identifier.

fn path(&self) -> &str

Get the path to the asset file within the archive.

fn hash(&self) -> &DocumentId

Get the content hash of the asset.

fn size(&self) -> u64

Get the size in bytes.

fn mime_type(&self) -> &str

Get the MIME type.

impl Clone for ImageAsset

fn clone(&self) -> ImageAsset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageAsset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageAsset

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImageAsset

fn eq(&self, other: &ImageAsset) -> 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 ImageAsset

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 ImageAsset