Skip to main content

LayerKvCache

Struct LayerKvCache 

Source
pub struct LayerKvCache {
    pub config: KVCacheConfig,
    /* private fields */
}
Expand description

Cheap to clone (an Arc around the shared, lock-guarded buffer) — matches the shared-state pattern used elsewhere in this crate (e.g. ClusterState).

Fields§

§config: KVCacheConfig

Implementations§

Source§

impl LayerKvCache

Source

pub fn new(config: KVCacheConfig) -> Self

Creates an empty cache. Does not allocate the backing buffer yet — initialize() performs the single upfront allocation, sized once for config.max_tokens_per_seq.

Source

pub fn initialize(&self, seq_len: usize) -> Result<(), String>

Ensures the backing buffer exists (allocating it on the first call only) and marks the first seq_len tokens (clamped to config.max_tokens_per_seq) as valid.

Safe to call again on the same cache — e.g. to grow current_len as more tokens are generated — without losing previously written data: the buffer is allocated once and never reallocated by this method.

Source

pub fn write_kv( &self, token_idx: usize, keys: &[f32], values: &[f32], ) -> Result<(), String>

Writes one token’s key/value vectors into the cache at token_idx. Copies directly into the pre-allocated buffer slice — no allocation.

Source

pub fn write_kv_batch( &self, entries: &[(usize, &[f32], &[f32])], ) -> Result<(), String>

Writes multiple tokens’ key/value vectors under a single write-lock acquisition, validating every entry upfront (before taking the lock) so a bad entry anywhere in the batch fails the whole call without partially writing it. Same per-token semantics as calling write_kv in a loop — this only changes how many times the lock is acquired.

Source

pub fn with_read_kv<F, R>(&self, token_idx: usize, f: F) -> Result<R, String>
where F: FnOnce(&[f32], &[f32]) -> R,

Inspects one token’s cached key/value slices directly under a read lock via a closure. Zero heap allocation on this path.

Source

pub fn with_read_range<F, R>( &self, start_token: usize, end_token: usize, f: F, ) -> Result<R, String>
where F: FnOnce(KVSpan<'_>) -> R,

Inspects keys/values for a contiguous token range ([start_token, end_token)) directly under a read lock via a closure that accepts a KVSpan. Zero heap allocation on this path.

Source

pub fn read_range_into( &self, start_token: usize, end_token: usize, keys_out: &mut [f32], values_out: &mut [f32], ) -> Result<(), String>

Copies keys and values for a contiguous token range into pre-allocated caller slices keys_out and values_out. Rejects output buffers if they are too small for the requested token range.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Clone for LayerKvCache

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 Debug for LayerKvCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LayerKvCache

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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