Skip to main content

RawFrameCache

Struct RawFrameCache 

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

A cache that stores raw pixel byte buffers (e.g. decoded video frames) keyed by frame number.

When the cache reaches RAW_FRAME_CACHE_CAPACITY entries the least-recently used frame is evicted before inserting the new one.

§Example

use oximedia_edit::render::RawFrameCache;

let mut cache = RawFrameCache::new(4);
let data = cache.get_or_render(0, || vec![0u8; 1024]);
assert_eq!(data.len(), 1024);

Implementations§

Source§

impl RawFrameCache

Source

pub fn new(capacity: usize) -> Self

Create a new cache with the given capacity (clamped to at least 1).

Source

pub fn get_or_render( &mut self, frame_num: u64, render_fn: impl FnOnce() -> Vec<u8>, ) -> &[u8]

Return a reference to the cached bytes for frame_num, rendering and inserting them via render_fn if not already present.

The rendered bytes are stored in the cache; on subsequent calls the same reference is returned without invoking render_fn.

When the cache is full the oldest frame is evicted first (LRU by insertion order).

Source

pub fn get(&self, frame_num: u64) -> Option<&[u8]>

Return a reference to the cached bytes for frame_num without rendering.

Returns None if the frame is not in the cache.

Source

pub fn insert(&mut self, frame_num: u64, data: Vec<u8>)

Explicitly insert pre-rendered bytes for frame_num.

If the frame already exists it is replaced. If the cache is full the oldest frame is evicted.

Source

pub fn invalidate(&mut self, frame_num: u64)

Invalidate (remove) the cache entry for frame_num, if present.

Source

pub fn clear(&mut self)

Clear all cached frames.

Source

pub fn len(&self) -> usize

Return the number of frames currently in the cache.

Source

pub fn is_empty(&self) -> bool

Return true if the cache contains no frames.

Source

pub fn capacity(&self) -> usize

Return the maximum number of frames this cache holds.

Source

pub fn contains(&self, frame_num: u64) -> bool

Return true if a frame for frame_num is present in the cache.

Trait Implementations§

Source§

impl Debug for RawFrameCache

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,