Struct wkwrap::header::Header

pub struct Header {
    pub version: u8,
    pub block_len_log2: u8,
    pub file_len_log2: u8,
    pub block_type: BlockType,
    pub voxel_type: VoxelType,
    pub voxel_size: u8,
    pub data_offset: u64,
    pub jump_table: Option<Box<[u64]>>,
}

Fields

version: u8

block_len_log2: u8

file_len_log2: u8

block_type: BlockType

voxel_type: VoxelType

voxel_size: u8

data_offset: u64

jump_table: Option<Box<[u64]>>

Methods

impl Header

pub fn from_template(template: &Header) -> Header

pub fn compress(template: &Header) -> Header

pub fn size_on_disk(&self) -> usize

pub fn read(file: &mut File) -> Result<Header>

pub fn write(&self, file: &mut File) -> Result<()>

pub fn block_offset(&self, block_idx: u64) -> Result<u64>

pub fn block_size_on_disk(&self, block_idx: u64) -> Result<usize>

pub fn max_block_size_on_disk(&self) -> usize

pub fn voxel_type_size(&self) -> usize

pub fn num_channels(&self) -> usize

pub fn is_multi_channel(&self) -> bool

pub fn to_bytes(&self) -> [u8; 16]

pub fn block_len(&self) -> u16

pub fn block_vol(&self) -> u64

pub fn block_size(&self) -> usize

pub fn file_len(&self) -> u16

pub fn file_vol(&self) -> u64

pub fn file_len_vx_log2(&self) -> u8

pub fn file_len_vx(&self) -> u32

pub fn file_vol_vx(&self) -> u64

pub fn file_size(&self) -> usize

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Header

fn eq(&self, __arg_0: &Header) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Header) -> bool

This method tests for !=.