Struct freqfs::Cache

source · [−]

pub struct Cache<FE> { /* private fields */ }

Expand description

An in-memory cache layer over tokio::fs with least-frequently-used (LFU) eviction.

Implementations

source

impl<FE: FileLoad + Send + Sync + 'static> Cache<FE>

source

pub fn new(
 capacity: usize,
 cleanup_interval: Duration,
 max_file_handles: Option<usize>
) -> Arc<Self>

Initialize the cache.

cleanup_interval specifies how often cache cleanup should run in the background. max_file_handles specifies how many files are allowed to be evicted at once. If not specified, max_file_handles will default to 512.

This function should only be called once.

Panics: if max_file_handles is Some(0)

source

pub async fn load(self: Arc<Self>, path: PathBuf) -> Result<DirLock<FE>, Error>

Load a filesystem directory into the cache.

After loading, all interactions with files under this directory should go through a DirLock or FileLock.

Auto Trait Implementations

impl<FE> RefUnwindSafe for Cache<FE>

impl<FE> Send for Cache<FE> where
FE: Send + Sync,

impl<FE> Sync for Cache<FE> where
FE: Send + Sync,

impl<FE> Unpin for Cache<FE>

impl<FE> UnwindSafe for Cache<FE>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

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

Mutably borrows from an owned value. Read more

source

impl<F, T> CastFrom<F> for T where
T: From<F>,

source

pub fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.

source

impl<T, F> CastInto<F> for T where
F: CastFrom<T>,

source

pub fn cast_into(self) -> F

Cast an instance of Self into an instance of T.

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

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

source

pub fn into(self) -> U

Performs the conversion.

source

impl<F> Match for F

source

fn matches<T>(&self) -> bool where
T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.

source

impl<F, T> TryCastFrom<F> for T where
T: CastFrom<F>,

source

pub fn can_cast_from(&F) -> bool

Test if value can be cast into Self.

source

pub fn opt_cast_from(f: F) -> Option<T>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

source

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err> where
OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.

source

impl<F, T> TryCastInto<T> for F where
T: TryCastFrom<F>,

source

pub fn can_cast_into(&self) -> bool

Test if self can be cast into T.

source

pub fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.

source

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err> where
OnErr: FnOnce(&Self) -> Err,

Returns Ok(T) if self can be cast into T, otherwise calls on_err.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct freqfs::Cache

Implementations

impl<FE: FileLoad + Send + Sync + 'static> Cache<FE>

pub fn new( capacity: usize, cleanup_interval: Duration, max_file_handles: Option<usize>) -> Arc<Self>

pub async fn load(self: Arc<Self>, path: PathBuf) -> Result<DirLock<FE>, Error>

Auto Trait Implementations

impl<FE> RefUnwindSafe for Cache<FE>

impl<FE> Send for Cache<FE> where FE: Send + Sync,

impl<FE> Sync for Cache<FE> where FE: Send + Sync,

impl<FE> Unpin for Cache<FE>

impl<FE> UnwindSafe for Cache<FE>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<F, T> CastFrom<F> for T where T: From<F>,

pub fn cast_from(f: F) -> T

impl<T, F> CastInto<F> for T where F: CastFrom<T>,

pub fn cast_into(self) -> F

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<F> Match for F

fn matches<T>(&self) -> bool where T: TryCastFrom<Self>,

impl<F, T> TryCastFrom<F> for T where T: CastFrom<F>,

pub fn can_cast_from(&F) -> bool

pub fn opt_cast_from(f: F) -> Option<T>

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err> where OnErr: FnOnce(&T) -> Err,

impl<F, T> TryCastInto<T> for F where T: TryCastFrom<F>,

pub fn can_cast_into(&self) -> bool

pub fn opt_cast_into(self) -> Option<T>

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err> where OnErr: FnOnce(&Self) -> Err,

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

type Error = Infallible

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

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

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

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

pub fn new(
capacity: usize,
cleanup_interval: Duration,
max_file_handles: Option<usize>
) -> Arc<Self>

impl<FE> Send for Cache<FE> where
FE: Send + Sync,

impl<FE> Sync for Cache<FE> where
FE: Send + Sync,

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

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

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

impl<F, T> CastFrom<F> for T where
T: From<F>,

impl<T, F> CastInto<F> for T where
F: CastFrom<T>,

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

fn matches<T>(&self) -> bool where
T: TryCastFrom<Self>,

impl<F, T> TryCastFrom<F> for T where
T: CastFrom<F>,

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err> where
OnErr: FnOnce(&T) -> Err,

impl<F, T> TryCastInto<T> for F where
T: TryCastFrom<F>,

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err> where
OnErr: FnOnce(&Self) -> Err,

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

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