Skip to main content

ThumbnailConfig

Struct ThumbnailConfig 

Source
pub struct ThumbnailConfig {
    pub max_width: u32,
    pub max_height: u32,
    pub format: ImageFormat,
}
Expand description

Configuration builder for image thumbnail generation.

Encapsulates maximum bounding box constraints and the target output image encoding format.

§Examples

use image::ImageFormat;
use scyph_storage::thumbnail::ThumbnailConfig;

let config = ThumbnailConfig::new(300, 300)
    .with_format(ImageFormat::Png);

assert_eq!(config.max_width, 300);
assert_eq!(config.max_height, 300);
assert_eq!(config.format, ImageFormat::Png);

Fields§

§max_width: u32

Maximum allowable width in pixels.

§max_height: u32

Maximum allowable height in pixels.

§format: ImageFormat

Target image encoding format for the generated thumbnail (default: JPEG).

Implementations§

Source§

impl ThumbnailConfig

Source

pub const fn new(max_width: u32, max_height: u32) -> ThumbnailConfig

Creates a new ThumbnailConfig with custom maximum width and height bounds.

By default, encodes output as JPEG.

§Arguments
  • max_width - Maximum thumbnail width in pixels.
  • max_height - Maximum thumbnail height in pixels.
Source

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

Configures the destination image encoding format (e.g. JPEG, PNG, WebP).

§Arguments
Source

pub async fn generate( &self, data: impl Into<Bytes>, ) -> Result<Vec<u8>, StorageError>

Generates a thumbnail buffer from the provided raw image bytes using this configuration.

Preserves original aspect ratio while scaling down to fit within (max_width, max_height).

§Arguments
  • data - Raw bytes of the source image (cheaply shared if Bytes).
§Errors

Returns StorageError::ValidationError if image format is unsupported or bytes are corrupt, or StorageError::Internal if re-encoding fails.

Source

pub const fn content_type(&self) -> &'static str

Returns the canonical MIME content-type string for this configuration’s target output format.

§Examples
use image::ImageFormat;
use scyph_storage::thumbnail::ThumbnailConfig;

let config = ThumbnailConfig::default().with_format(ImageFormat::WebP);
assert_eq!(config.content_type(), "image/webp");
Source

pub const fn extension(&self) -> &'static str

Returns the canonical file extension (without leading dot) for this configuration’s format.

Source

pub fn derive_key(&self, original_key: &str, subfolder: &str) -> String

Derives the destination storage key for a thumbnail based on this configuration’s format.

Replaces the original extension with the target format extension and places the file in subfolder.

§Examples
use image::ImageFormat;
use scyph_storage::thumbnail::ThumbnailConfig;

let config = ThumbnailConfig::default().with_format(ImageFormat::WebP);
let key = config.derive_key("avatars/user.png", "thumbnails");
assert_eq!(key, "avatars/thumbnails/user.webp");

Trait Implementations§

Source§

impl Clone for ThumbnailConfig

Source§

fn clone(&self) -> ThumbnailConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ThumbnailConfig

Source§

impl Debug for ThumbnailConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ThumbnailConfig

Source§

fn default() -> ThumbnailConfig

Returns the “default value” for a type. Read more
Source§

impl Eq for ThumbnailConfig

Source§

impl PartialEq for ThumbnailConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ThumbnailConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsOut<T> for T
where T: Copy,

Source§

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.
Source§

impl<T> Authorizable for T
where T: Copy + Eq + Send + Sync + 'static,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T, O> Matches<O> for T
where T: PartialEq<O>,

Source§

fn validate_matches(&self, other: &O) -> bool

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more