Struct ImageAssetOptions

pub struct ImageAssetOptions { /* private fields */ }

Options for an image asset

Implementations

impl ImageAssetOptions

pub const fn new() -> Self

Create a new image asset options

pub const fn with_preload(self, preload: bool) -> Self

Make the asset preloaded

Preloading an image will make the image start to load as soon as possible. This is useful for images that will be displayed soon after the page loads or images that may not be visible immediately, but should start loading sooner

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_preload(true));

pub const fn preloaded(&self) -> bool

Check if the asset is preloaded

pub const fn with_format(self, format: ImageFormat) -> Self

Sets the format of the image

Choosing the right format can make your site load much faster. Webp and avif images tend to be a good default for most images

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_format(ImageFormat::Webp));

pub const fn with_avif(self) -> Self

Sets the format of the image to ImageFormat::Avif

Avif images tend to be a good default for most images rendered in browser because they compress images well

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_avif());

pub const fn with_webp(self) -> Self

Sets the format of the image to ImageFormat::Webp

Webp images tend to be a good default for most images rendered in browser because they compress images well

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_webp());

pub const fn with_jpg(self) -> Self

Sets the format of the image to ImageFormat::Jpg

Jpeg images compress much better than ImageFormat::Png, but worse than ImageFormat::Webp or ImageFormat::Avif

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_jpg());

pub const fn with_png(self) -> Self

Sets the format of the image to ImageFormat::Png

Png images don’t compress very well, so they are not recommended for large images

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_png());

pub const fn format(&self) -> ImageFormat

Get the format of the image

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

Sets the size of the image

If you only use the image in one place, you can set the size of the image to the size it will be displayed at. This will make the image load faster

const _: Asset = asset!("/assets/image.png", ImageAssetOptions::new().with_size(ImageSize::Manual { width: 512, height: 512 }));

pub const fn size(&self) -> ImageSize

Get the size of the image

pub const fn into_asset_options(self) -> AssetOptions

Convert the options into options for a generic asset

Trait Implementations

impl Clone for ImageAssetOptions

fn clone(&self) -> ImageAssetOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageAssetOptions

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

Formats the value using the given formatter.

impl Default for ImageAssetOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageAssetOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ImageAssetOptions

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 PartialEq for ImageAssetOptions

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

fn partial_cmp(&self, other: &ImageAssetOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ImageAssetOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SerializeConst for ImageAssetOptions

const MEMORY_LAYOUT: Layout

The memory layout of the type. This type must have plain old data; no pointers or references.

const _ASSERT: () = _

Assert that the memory layout of the type is the same as the size of the type

impl Copy for ImageAssetOptions

impl StructuralPartialEq for ImageAssetOptions