Struct Placement 

pub struct Placement { /* private fields */ }

Where the footer is, read from the trailer.

This is the first thing a host learns about a container and the only thing it can learn without being told where to look, because the trailer is at a known distance from the end. Everything else follows from it.

Implementations

impl Placement

pub const TRAILER_LEN: usize = TRAILER_SIZE

How many bytes at the end of the file the trailer occupies.

pub fn trailer_at(file_len: u64) -> Result<u64>

Where the trailer starts in a file of this length.

Errors

Error::Truncated if the file is too short to be a container at all, which is checked here so that a host cannot be told to read from a negative offset.

pub fn read(trailer: &[u8], file_len: u64) -> Result<Self>

Reads the trailer of a file of file_len bytes.

trailer is the Placement::TRAILER_LEN bytes at Placement::trailer_at.

Errors

Error::Truncated if the file is too short or does not end with the magic, Error::Reserved if a field that has to be zero is not, and Error::Truncated again if the footer the trailer names does not fit between the header and the trailer.

pub const fn file_len(&self) -> u64

How long the file is.

pub const fn footer_at(&self) -> u64

Where the footer starts.

pub const fn footer_len(&self) -> usize

How long the footer is.

A usize because it is a u32 in the file and every target this builds for has a usize at least that wide, so a host can read it in one call without a conversion that could fail.

pub const fn root_digest(&self) -> Digest

The digest that covers the header and the footer.

Trait Implementations

impl Clone for Placement

fn clone(&self) -> Placement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Placement

impl Debug for Placement

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

Formats the value using the given formatter.

impl Eq for Placement

impl PartialEq for Placement

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Placement