Struct Variant 

pub struct Variant { /* private fields */ }

A resized version of an image, made by Cloudflare Image Transformations (Active Storage’s variants).

Variant::path builds /cdn-cgi/image/<options>/<source>: Cloudflare’s edge fetches the source image (for example the app’s own route that serves it), resizes it and caches the result. Variants are lazy (made on the first request, like Rails’ variant(...).processed on first view) and never touch the Worker’s CPU or R2’s storage. format=auto is always set: browsers that accept AVIF or WebP get it, others get the original format.

Needs a custom domain (a zone on Cloudflare) with Transformations turned on in the dashboard (Images > Transformations); *.workers.dev hosts cannot use it. Declare variants as constants, like Rules.

Examples

use ocre::storage::{Fit, Variant};

const THUMB: Variant = Variant::new().width(300).height(300).fit(Fit::Cover).quality(80);
const LARGE: Variant = Variant::new().width(1600);

assert_eq!(
    THUMB.path("/photos/7/image"),
    "/cdn-cgi/image/width=300,height=300,fit=cover,quality=80,format=auto/photos/7/image"
);
assert_eq!(LARGE.path("https://files.example.com/a.jpg"), "/cdn-cgi/image/width=1600,format=auto/https://files.example.com/a.jpg");

Implementations

impl Variant

pub const fn new() -> Self

A variant with no resizing: only format=auto.

Examples

assert_eq!(ocre::storage::Variant::new().path("/logo.png"), "/cdn-cgi/image/format=auto/logo.png");

pub const fn width(self, pixels: u32) -> Self

Sets the largest width, in pixels.

Examples

let path = ocre::storage::Variant::new().width(640).path("/a.png");
assert_eq!(path, "/cdn-cgi/image/width=640,format=auto/a.png");

pub const fn height(self, pixels: u32) -> Self

Sets the largest height, in pixels.

Examples

let path = ocre::storage::Variant::new().height(480).path("/a.png");
assert_eq!(path, "/cdn-cgi/image/height=480,format=auto/a.png");

pub const fn fit(self, fit: Fit) -> Self

Sets how the image fits the width × height box; without it, Cloudflare scales the image down to fit.

Examples

use ocre::storage::{Fit, Variant};

let path = Variant::new().width(100).height(100).fit(Fit::Pad).path("/a.png");
assert_eq!(path, "/cdn-cgi/image/width=100,height=100,fit=pad,format=auto/a.png");

pub const fn quality(self, quality: u8) -> Self

Sets the JPEG/WebP/AVIF quality, 1 to 100 (values outside are clamped).

Examples

let path = ocre::storage::Variant::new().quality(200).path("/a.jpg");
assert_eq!(path, "/cdn-cgi/image/quality=100,format=auto/a.jpg");

pub fn path(&self, source: &str) -> String

The same-origin path of this variant of source: /cdn-cgi/image/<options>/<source>.

source is a path on the same zone (/photos/1/image, the leading / is dropped as Cloudflare expects) or an absolute https:// URL (allowed in the zone’s Transformations settings). Pure; use it in templates as src="{{ THUMB.path(photo_path) }}".

Examples

let path = ocre::storage::Variant::new().width(64).path("//avatars/1");
assert_eq!(path, "/cdn-cgi/image/width=64,format=auto/avatars/1");

Trait Implementations

impl Clone for Variant

fn clone(&self) -> Variant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Variant

impl Debug for Variant

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

Formats the value using the given formatter.

impl Default for Variant

fn default() -> Variant

Returns the “default value” for a type.

impl Eq for Variant

impl PartialEq for Variant

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