Enum RawCounts 

pub enum RawCounts {
    U16(Vec<u16>),
    U32(Vec<u32>),
}

Wrapper enum for raw counts that supports both u16 and u32 storage.

Most single cell data sets have counts well within the u16 range (0-65,535). The u32 variant exists for edge cases such as mixed-omics data where counts can exceed this limit. The variant is selected automatically at construction time based on the data, and is encoded as a discriminant byte in the binary chunk format.

Variants

U16(Vec<u16>)

Stores u16 values

U32(Vec<u32>)

Stores u32 values (for the rare case where a single gene exceeds the counts here)

Implementations

impl RawCounts

pub fn get(&self, i: usize) -> u32

Get a single value as u32

Returns

The count as u32

pub fn len(&self) -> usize

Total number of elements

Returns

The length of elements

pub fn is_empty(&self) -> bool

Whether the vector is empty

Returns

Boolean if the data is empty

pub fn iter(&self) -> RawCountsIter<'_>

Iterator that yields all values as u32

Returns

An iterator

pub fn elem_size(&self) -> u8

Element size in bytes (2 for u16, 4 for u32)

Returns

The element size

pub fn write_bytes(&self, writer: &mut impl Write) -> Result<()>

Write raw bytes to a writer

Params

• writer - The writer to use

Returns

The I/O result

pub fn read_from_buffer( buffer: &[u8], count: usize, elem_size: u8, ) -> Result<Self, ScDataErrors>

Read raw counts from a buffer given element size and count

Params

• buffer - The byte buffer to read from (must be positioned at the start of the raw count data)
• count - Number of elements to read
• elem_size - Element size in bytes (2 for u16, 4 for u32)

Returns

The RawCounts, or ScDataErrors::RawElemSizeInvalid if the discriminant is unrecognised, or ScDataErrors::ChunkPayloadTruncated if the buffer is shorter than count * elem_size.

pub fn from_u32_auto(data: &[u32]) -> Self

Build RawCounts from a u32 slice, auto-selecting the variant.

If all values fit in u16, stores as U16 for better compression. Otherwise stores as U32.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for RawCounts

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for RawCounts

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawCounts

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for RawCounts

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for RawCounts

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for RawCounts

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Serialize for RawCounts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.