Struct calypso_filety::ccff::ContainerFile

pub struct ContainerFile { /* private fields */ }

A CCFF container file.

This will contain all the sections of data (somewhat similar in theory to ELF sections) as well as some basic metadata about the file: its ABI version and file type, both of which are user-defined.

It also stores a list of Sections, which can be accessed and modified via methods on this structure such as get_section and add_section. The order of these sections is stored, however this is not guaranteed or required and may be changed in the future.

Implementations

impl ContainerFile

pub fn new(abiver: u16, filety: u8) -> Self

Create a new container file. The ABI version (abiver) and file type (filety) may be any arbitrary user-defined value.

pub fn set_abiver(&mut self, abiver: u16)

Set the ABI version of the container file. This may be any arbitrary user-defined value.

pub fn get_abiver(&self) -> u16

Get the ABI version of the container file.

pub fn set_filety(&mut self, filety: u8)

Set the file type of the container file. This may be any arbitrary user-defined value.

pub fn get_filety(&self) -> u8

Get the file type of the container file.

pub fn add_section(&mut self, name: Symbol, section: Section) -> Option<Section>

Add a section to the container file. If there was already a section with this name present, it will be replaced and returned.

Panics

This function will panic if the name of the section was longer than 255 characters, if the name of the section contained non-printable ASCII characters (less than 0x21 or greater than 0x7E), or if there were already 255 sections in the container file.

pub fn remove_section(&mut self, name: Symbol) -> Option<Section>

Remove a section from the container file. The removed section, if any, will be returned.

pub fn get_section(&self, name: Symbol) -> Option<&Section>

Get a reference to a section in the container file.

pub fn get_section_mut(&mut self, name: Symbol) -> Option<&mut Section>

Get a mutable reference to a section in the container file.

pub fn sections(&self) -> impl Iterator<Item = (&Symbol, &Section)>

Iterate over the sections in the container file.

pub fn sections_mut(&mut self) -> impl Iterator<Item = (&Symbol, &mut Section)>

Iterate mutably over the sections in the container file.

pub fn size(&self) -> usize

Get the size of the entire container file.

pub fn decode(buf: &[u8]) -> CalResult<Self>

Decode this container file from the buffer provided.

Errors

This function will return an error (specifically, a nom::Err boxed in an eyre::Report) if the input fails to parse.

pub fn encode_to(self, buf: &mut Vec<u8>)

Encode this container file to the buffer provided. To allocate a sufficiently sized buffer, use Vec::with_capacity using the size given by ContainerFile::size.

Panics

This function will panic if a section was too large (larger than u32::MAX in bytes) or if there was too much data in the container file (due to architectural limitations, they are capped at around 4GiB)

pub fn encode(self) -> Vec<u8>

Encode this container file to a newly allocated buffer.

Trait Implementations

impl Clone for ContainerFile

fn clone(&self) -> ContainerFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerFile

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

Formats the value using the given formatter.

impl IntoIterator for ContainerFile

type IntoIter = IntoIter<Symbol, Section>

Which kind of iterator are we turning this into?

type Item = (Symbol, Section)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<ContainerFile> for ContainerFile

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

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

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

This method tests for !=.

impl Eq for ContainerFile

impl StructuralEq for ContainerFile

impl StructuralPartialEq for ContainerFile