Skip to main content

PersonalThumbnailInstallRequest

Struct PersonalThumbnailInstallRequest 

Source
pub struct PersonalThumbnailInstallRequest { /* private fields */ }
Expand description

Owned personal-cache install request for async or runtime-specific adapters.

Constructing this request does not perform filesystem I/O. Normalization and installation happen only when Self::install_path or Self::install_png_bytes is called. Constructing a ReadablePersonalOriginalIdentity from a local path performs blocking filesystem I/O, so async callers should do that inside their runtime’s blocking adapter too.

use xdg_thumbnail::{
    PersonalCacheRoot, PersonalThumbnailInstallRequest, ReadablePersonalOriginalIdentity, ThumbnailSize,
};

fn spawn_blocking<F, R>(operation: F) -> R
where
    F: FnOnce() -> R + Send + 'static,
    R: Send + 'static,
{
    operation()
}

fn render_thumbnail_png() -> Vec<u8> {
    unimplemented!("return PNG bytes produced by the caller's renderer")
}

fn main() -> xdg_thumbnail::Result<()> {
    let root = PersonalCacheRoot::resolve_from_env()?;
    let rendered_png = render_thumbnail_png();

    let installed = spawn_blocking(move || {
        let original =
            ReadablePersonalOriginalIdentity::from_local_path("/home/alice/Pictures/photo.png")?;
        let request = PersonalThumbnailInstallRequest::new(
            root,
            original,
            ThumbnailSize::Normal,
            rendered_png,
        );
        request.install_png_bytes()
    })?;
    let _path = installed.path();
    Ok(())
}

Implementations§

Source§

impl PersonalThumbnailInstallRequest

Source

pub fn new( root: PersonalCacheRoot, original: ReadablePersonalOriginalIdentity, size: ThumbnailSize, rendered_png: Vec<u8>, ) -> Self

Creates an owned personal-cache install request.

Source

pub fn install_path(self) -> Result<InstalledThumbnailPath>

Normalizes rendered PNG data, installs a personal-cache thumbnail, and returns its path.

§Errors

Returns the same errors as PersonalCacheRoot::install_thumbnail_returning_path.

Source

pub fn install_png_bytes(self) -> Result<InstalledThumbnailPngBytes>

Normalizes rendered PNG data, installs a personal-cache thumbnail, and returns final PNG bytes.

§Errors

Returns the same errors as PersonalCacheRoot::install_thumbnail_returning_png_bytes.

Source

pub fn into_parts(self) -> PersonalThumbnailInstallRequestParts

Splits this request into its owned parts.

Trait Implementations§

Source§

impl Debug for PersonalThumbnailInstallRequest

Source§

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

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

impl PartialEq for PersonalThumbnailInstallRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for PersonalThumbnailInstallRequest

Source§

impl StructuralPartialEq for PersonalThumbnailInstallRequest

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> 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.