Enum KvRole 

#[non_exhaustive]
pub enum KvRole {
    Key,
    Value,
    Fused,
}

KV-cache role for a block-paged tensor.

The wire value is a uint8 in the additional descriptor fields of a block-paged layout (see docs/spec/layouts/block-paged.md § Additional Descriptor Fields).

Examples

use hurray_core::layout::KvRole;

assert_eq!(KvRole::Key.wire_byte(), 0x00);
assert_eq!(KvRole::Value.wire_byte(), 0x01);
assert_eq!(KvRole::Fused.wire_byte(), 0x02);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Key

Key tensor (kv_role = 0x00).

Value

Value tensor (kv_role = 0x01).

Fused

Fused or non-KV generic tensor (kv_role = 0x02).

Implementations

impl KvRole

pub fn wire_byte(self) -> u8

Returns the wire byte for this role.

Examples

use hurray_core::layout::KvRole;

assert_eq!(KvRole::Key.wire_byte(), 0x00);
assert_eq!(KvRole::Value.wire_byte(), 0x01);
assert_eq!(KvRole::Fused.wire_byte(), 0x02);

pub fn from_wire(byte: u8) -> Option<Self>

Constructs a KvRole from its wire byte.

Returns None for unrecognized values (future spec extensions).

Examples

use hurray_core::layout::KvRole;

assert_eq!(KvRole::from_wire(0x00), Some(KvRole::Key));
assert_eq!(KvRole::from_wire(0x03), None);

Trait Implementations

impl Clone for KvRole

fn clone(&self) -> KvRole

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for KvRole

impl Debug for KvRole

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

Formats the value using the given formatter.

impl Eq for KvRole

impl Hash for KvRole

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KvRole

fn eq(&self, other: &KvRole) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KvRole