Skip to main content

PreviewClient

Struct PreviewClient 

Source
pub struct PreviewClient<'a, T: Transport, A: AuthProvider> { /* private fields */ }
Expand description

Client for fetching image previews and thumbnails from Nextcloud.

Executes calls through any Transport and applies credentials via an AuthProvider. Both are held by reference, allowing the client to be freely cloned or borrowed across tasks without runtime dispatch or connection pooling overhead.

Previews are generated by Nextcloud’s core preview endpoint at /core/preview.png (accessed via /index.php/core/preview.png).

Reference:

  • Official Nextcloud Preview endpoint: GET /core/preview.png?fileId={fileId}&x={x}&y={y}&a={a}&mode={mode} or GET /core/preview.png?file={filePath}&x={x}&y={y}

Implementations§

Source§

impl<'a, T: Transport, A: AuthProvider> PreviewClient<'a, T, A>

Source

pub const fn new(transport: &'a T, auth: &'a A) -> Self

Binds a preview client to a transport and credential provider.

Source

pub const fn transport(&self) -> &'a T

The transport this client sends requests through.

Source

pub const fn auth(&self) -> &'a A

The credential provider applied to every call.

Source

pub async fn get_by_file_id( &self, file_id: u64, options: &PreviewOptions, ) -> Result<Vec<u8>, Error>

Fetches a preview by numeric file cache ID (fileId).

Sends GET /index.php/core/preview.png?fileId={file_id}....

Returns the raw preview image bytes on success.

§Errors

Returns Error::Status if the server responds with a non-2xx status code, or Error::Transport if the underlying network request fails.

Source

pub async fn get_by_path( &self, path: &str, options: &PreviewOptions, ) -> Result<Vec<u8>, Error>

Fetches a preview by file path (file).

Sends GET /index.php/core/preview.png?file={path}....

Returns the raw preview image bytes on success.

§Errors

Returns Error::Status if the server responds with a non-2xx status code, or Error::Transport if the underlying network request fails.

Trait Implementations§

Source§

impl<'a, T: Clone + Transport, A: Clone + AuthProvider> Clone for PreviewClient<'a, T, A>

Source§

fn clone(&self) -> Self

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<'a, T: Copy + Transport, A: Copy + AuthProvider> Copy for PreviewClient<'a, T, A>

Source§

impl<'a, T: Debug + Transport, A: Debug + AuthProvider> Debug for PreviewClient<'a, T, A>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T, A> Freeze for PreviewClient<'a, T, A>

§

impl<'a, T, A> RefUnwindSafe for PreviewClient<'a, T, A>

§

impl<'a, T, A> Send for PreviewClient<'a, T, A>
where &'a T: Send, &'a A: Send,

§

impl<'a, T, A> Sync for PreviewClient<'a, T, A>
where &'a T: Sync, &'a A: Sync,

§

impl<'a, T, A> Unpin for PreviewClient<'a, T, A>

§

impl<'a, T, A> UnsafeUnpin for PreviewClient<'a, T, A>

§

impl<'a, T, A> UnwindSafe for PreviewClient<'a, T, A>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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<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