Struct Container 

pub struct Container {
    pub declared_size: u64,
    pub first_chunk: u64,
    pub head: Option<Head>,
    pub chunks: Vec<Chunk>,
    pub trailing: usize,
    /* private fields */
}

A parsed .clip container. Holds the original bytes.

Fields

declared_size: u64

File size the header declares.

first_chunk: u64

Offset of the first chunk the header declares (24).

head: Option<Head>

The CHNKHead contents, if the file has one.

chunks: Vec<Chunk>

Every chunk, in file order.

trailing: usize

Bytes after the footer chunk (none in CSP files).

Implementations

impl Container

pub fn read(path: impl AsRef<Path>) -> Result<Self>

Reads and parses a file.

pub fn sniff(data: &[u8]) -> bool

Whether data starts like a .clip container.

pub fn parse(data: Vec<u8>) -> Result<Self>

Parses the bytes of a .clip; fails on a truncated or malformed container.

pub fn bytes(&self) -> &[u8]

The bytes as read.

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

The bytes as read, by value.

pub fn body(&self, chunk: &Chunk) -> &[u8]

The body of a chunk.

pub fn sqlite(&self) -> Result<&[u8]>

The embedded SQLite database image.

pub fn sqlite_chunk(&self) -> Option<&Chunk>

The database chunk.

pub fn external_chunks(&self) -> impl Iterator<Item = &Chunk>

External chunks in file order.

pub fn external_chunk(&self, id: &str) -> Option<&Chunk>

The external chunk with this id.

pub fn external(&self, id: &str) -> Option<&[u8]>

Payload of an external chunk (after its id). None when the id is not stored: CSP keeps ids of offscreens it will build on opening.

pub fn external_ids(&self) -> impl Iterator<Item = &str>

Ids of the external chunks, in file order.

pub fn findings(&self) -> Vec<String>

Structural problems that do not stop reading (empty when CSP-like).

pub fn reassemble(&self) -> Vec<u8>

Rebuild the file from its parsed parts (used to prove the parser misses nothing: the result must equal Container::bytes).

Trait Implementations

impl Clone for Container

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 Container

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

Formats the value using the given formatter.