Skip to main content

Cache

Struct Cache 

Source
pub struct Cache<S: CacheStorage> { /* private fields */ }
Expand description

Cache handler. Mount on a trillium_client::Client together with a CacheStorage backend.

Cache is cheap to Clone: storage is held in an Arc, so clones share the same backend.

Implementations§

Source§

impl<S: CacheStorage> Cache<S>

Source

pub fn new(storage: S) -> Self

Construct a cache handler with default options (CacheOptions::default) and a 16 MiB body-size cap.

Source

pub fn with_options(self, options: CacheOptions) -> Self

Replace the cache options.

Source

pub fn shared(self) -> Self

Mark this cache as a shared cache (proxy/CDN). Equivalent to with_options with shared: true.

Source

pub fn with_max_cacheable_size(self, max: u64) -> Self

Set the cap on response body bytes the cache will store. Responses larger than this pass through but are not stored. If the cap is exceeded mid-stream, the cache write is aborted and the remainder of the body passes through unmodified.

Source

pub fn storage(&self) -> &S

Borrow the storage backend.

Trait Implementations§

Source§

impl<S: CacheStorage> ClientHandler for Cache<S>

Source§

async fn run(&self, conn: &mut Conn) -> Result<()>

Forward-pass hook, called before the network round-trip in declared order. Read more
Source§

async fn after_response(&self, conn: &mut Conn) -> Result<()>

Reverse-pass hook, called after the network round-trip (or after a halt-skipped network call) in reverse declared order. Always runs regardless of halt status or transport error. Read more
Source§

fn name(&self) -> Cow<'static, str>

Human-readable name for logging/debugging. Defaults to the type name.
Source§

impl<S: CacheStorage> Clone for Cache<S>

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<S: Debug + CacheStorage> Debug for Cache<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for Cache<S>

§

impl<S> RefUnwindSafe for Cache<S>
where S: RefUnwindSafe,

§

impl<S> Send for Cache<S>

§

impl<S> Sync for Cache<S>

§

impl<S> Unpin for Cache<S>

§

impl<S> UnsafeUnpin for Cache<S>

§

impl<S> UnwindSafe for Cache<S>
where S: RefUnwindSafe,

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, 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> 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> 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 = 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.