Struct FftPlanCache 

pub struct FftPlanCache { /* private fields */ }

Bounded, caller-owned typed cache for backend FFT plans and workspaces.

crate::FftExecutor owns one cache and passes its store to every crate::FftBackend through crate::FftExecutionCache. Backends retain private Send + Sync + 'static values under their own [ExtensionCacheKey] namespace. Entry limits, LRU eviction, clearing, aggregate entry counts, and retained-byte accounting apply uniformly to CPU and non-CPU entries.

The CPU backend stores RustFFT plans in the private rustfft-plans namespace. Its retained-byte estimate includes the exact plan key and the cache-owned Arc handle; allocations opaque to RustFFT are excluded.

Examples

use std::num::NonZeroUsize;
use tenferro_fft::FftPlanCache;

let cache = FftPlanCache::with_capacity(NonZeroUsize::new(2).unwrap());
assert_eq!(cache.capacity().get(), 2);
assert_eq!(cache.stats().entries, 0);

Implementations

impl FftPlanCache

pub fn with_capacity(capacity: NonZeroUsize) -> Self

Create an empty typed cache with an explicit maximum entry count.

pub fn capacity(&self) -> NonZeroUsize

Maximum number of retained backend entries across all namespaces.

pub fn limits(&self) -> ExtensionCacheLimits

Return complete cache retention limits.

pub fn set_limits(&mut self, limits: ExtensionCacheLimits)

Replace complete cache retention limits.

pub fn set_capacity(&mut self, capacity: NonZeroUsize)

Resize the cache, evicting least-recently-used entries when necessary.

pub fn clear(&mut self)

Remove every retained backend plan or workspace.

pub fn stats(&self) -> CacheStats

Snapshot aggregate entries and backend-reported retained bytes.

Trait Implementations

impl Debug for FftPlanCache

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

Formats the value using the given formatter.

impl Default for FftPlanCache

fn default() -> Self

Returns the “default value” for a type.

impl RuntimeCacheControl for FftPlanCache

fn clear(&mut self)

Remove every retained cache entry.

fn stats(&self) -> CacheStats

Snapshot retained entries and retained bytes.