Struct ChunkFormat

Source

pub struct ChunkFormat {
    pub version: u32,
    pub codec: ChunkCodec,
    pub target_size: f32,
}

Expand description

How a writer encodes the chunks it appends.

Copied out of the writer so parallel payload builders can encode without borrowing it.

Fields§

§version: u32

File version: SC_FILE_VERSION or SC_FILE_VERSION_V3.

§codec: ChunkCodec

Body codec of v4 chunks. Unused by v3.

§target_size: f32

Target size in the file header, which readers recompute the norm layer with. 0.0 stores the norm layer verbatim.

Implementations§

Source §

impl ChunkFormat

Source

pub fn is_v4(&self) -> bool

Whether this format is the current (v4) one.

§Returns

true for v4.

Source

pub fn encode_cell(&self, chunk: &CsrCellChunk) -> Result<Vec<u8>, ScDataErrors>

Encode a cell chunk for a file of this format.

§Params

chunk - The cell

§Returns

The payload the writer’s write_compressed_cell_chunks expects.

Source

pub fn encode_gene( &self, chunk: &CscGeneChunk, cell_lib: &[f32], ) -> Result<Vec<u8>, ScDataErrors>

Encode a gene chunk for a file of this format.

§Params

chunk - The gene
cell_lib - Library size per cell as f32, the table the file will carry. Empty stores the norm layer verbatim.

§Returns

The payload the writer’s write_compressed_gene_chunks expects.

Trait Implementations§

Source §

impl Clone for ChunkFormat

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 Copy for ChunkFormat

Source §

impl Debug for ChunkFormat

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ChunkFormat

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

Source §

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source §

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source §

impl<T, U> Into 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 §