Skip to main content

KvStreamEncoder

Struct KvStreamEncoder 

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

Incremental/streaming KV-cache encoder.

Construct with KvStreamEncoder::new, feed tokens one at a time with KvStreamEncoder::append_token, and finalize with KvStreamEncoder::finish to obtain a KvEncodedTensorV1.

The encoder accumulates a BLAKE3 source digest over all appended vectors using an incremental blake3::Hasher. Pages are buffered as pending (blocks + metadata) and materialized into KvEncodedPageV1 objects in finish() once the full source digest is available, ensuring that page digests match the batch super::codec::encode_kv_tensor path.

Implementations§

Source§

impl KvStreamEncoder

Source

pub fn new( shape: KvTensorShapeV1, layout: KvCacheLayoutV1, profile: KvCompressionProfileV1, ) -> Result<Self>

Create a new streaming encoder.

Validates the shape, layout, and profile, then builds a quantizer from the profile. The source digest accumulator is initialized with the domain tag and expected total element count so that incremental hashing produces the same result as super::receipt::kv_tensor_digest.

Currently requires batch = 1, layers = 1, kv_heads = 1.

Source

pub fn append_token( &mut self, key_vector: &[f32], value_vector: &[f32], ) -> Result<AppendReceipt>

Append one token’s key and value vectors.

Both vectors must have length head_dim and contain only finite values. Only the vector matching shape.role is encoded into a block; the other is reported as "raw" in the receipt with zero compressed bytes (it is not stored in this encoder’s output).

When the current page reaches tokens_per_page blocks, the blocks are flushed to a pending page buffer (materialized in finish()).

Source

pub fn finish(self) -> Result<KvEncodedTensorV1>

Finalize the stream and produce the encoded tensor.

Flushes any remaining blocks as the final page, computes the source digest, materializes all pending pages, and builds the compression receipt.

Returns an error if the number of appended tokens does not match shape.tokens.

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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V