Struct PreviewOptions 

pub struct PreviewOptions { /* private fields */ }

Parameters for generating a thumbnail or preview image.

Corresponds to the query parameters accepted by Nextcloud’s preview endpoint:

• x: Width in pixels
• y: Height in pixels
• a: Whether to keep aspect ratio (1 or 0)
• mode: Scaling mode ("cover" or "fill")

Implementations

impl PreviewOptions

pub const fn new() -> Self

Creates an empty set of preview options.

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

Sets the desired preview width in pixels (x parameter).

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

Sets the desired preview height in pixels (y parameter).

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

Sets both width and height in pixels (x and y parameters).

pub const fn keep_aspect_ratio(self, keep: bool) -> Self

Specifies whether to keep the image aspect ratio (a parameter).

When true, Nextcloud preserves the aspect ratio (a=1). When false, Nextcloud crops or distorts (a=0).

pub const fn mode(self, mode: PreviewMode) -> Self

Sets the scaling mode (mode parameter).

pub const fn width_px(&self) -> Option<u32>

The desired preview width in pixels, if specified.

pub const fn height_px(&self) -> Option<u32>

The desired preview height in pixels, if specified.

pub const fn aspect_ratio(&self) -> Option<bool>

Whether aspect ratio should be preserved, if specified.

pub const fn preview_mode(&self) -> Option<PreviewMode>

The scaling mode, if specified.

Trait Implementations

impl Clone for PreviewOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PreviewOptions

impl Debug for PreviewOptions

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

Formats the value using the given formatter.

impl Default for PreviewOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PreviewOptions

impl PartialEq for PreviewOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PreviewOptions