Struct Bom

pub struct Bom { /* private fields */ }

BOM file low-level representation.

Contains regular and named blocks.

Implementations

impl Bom

pub fn new() -> Self

Create a new empty BOM.

pub fn blocks(&self) -> &Blocks

Get all regular blocks.

pub fn named_blocks(&self) -> &NamedBlocks

Get all named blocks.

pub fn write_named<N, W, C, T>( &mut self, name: N, writer: W, value: &T, context: &mut C, ) -> Result<(), Error>

where N: Into<CString>, W: Write + Seek, T: BlockWrite<C>,

Write value into a new named block.

pub fn get_named(&self, name: &CStr) -> Option<u32>

Get block index by name.

pub fn read_named<C, T: BlockRead<C>>( &mut self, name: &CStr, file: &[u8], context: &mut C, ) -> Result<T, Error>

Read a value of type T from a named block.

pub fn read_regular<C, T: BlockRead<C>>( &mut self, block_index: u32, file: &[u8], context: &mut C, ) -> Result<T, Error>

Read a value of type T from a regular block.

pub fn read(file: &[u8]) -> Result<Self, Error>

Read BOM header from file.

pub fn write<W: Write + Seek>(&self, writer: W) -> Result<(), Error>

Write BOM header at the beginning of writer.

This method requires 512 byte to be reserved at the beginning of the file to not overwrite any important data.

Trait Implementations

impl Debug for Bom

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

Formats the value using the given formatter.

impl Default for Bom

fn default() -> Self

Returns the “default value” for a type.