Struct mp4ameta::Atom

pub struct Atom {
    pub head: [u8; 4],
    pub offset: usize,
    pub content: Content,
}

A structure that represents a MPEG-4 audio metadata atom.

Fields

head: [u8; 4]

The 4 byte identifier of the atom.

offset: usize

The offset in bytes separating the head from the content.

content: Content

The content of an atom.

Methods

impl Atom

pub fn new() -> Atom

Creates a new empty atom.

pub fn with(head: [u8; 4], offset: usize, content: Content) -> Atom

Creates an atom containing the provided content at a n byte offset.

pub fn with_raw_data(head: [u8; 4], offset: usize, data: Data) -> Atom

Creates an atom containing Content::RawData with the provided data.

pub fn data_atom() -> Atom

Creates a data atom containing unparsed Content::TypedData.

pub fn data_atom_with(data: Data) -> Atom

Creates a data atom containing Content::TypedData with the provided data.

pub fn len(&self) -> usize

Returns the length in bytes.

pub fn read_from(reader: &mut impl Read + Seek) -> Result<Vec<Atom>>

Attempts to read MPEG-4 audio metadata from the reader.

pub fn write_to(&self, writer: &mut impl Write) -> Result<()>

Attempts to write the MPEG-4 audio metadata to the writer.

pub fn parse(&mut self, reader: &mut impl Read + Seek) -> Result<()>

Attempts to parse itself from the reader.

pub fn parse_atoms(
    atoms: &mut Vec<Atom>,
    reader: &mut impl Read + Seek,
    length: usize
) -> Result<()>

Attempts to parse the list of atoms from the reader.

pub fn locate_metadata_item_list(
    reader: &mut impl Read + Seek
) -> Result<Vec<(usize, usize)>>

Locates the metadata item list atom and returns a list of tuples containing the position from the beginning of the file and length in bytes of the atom hierarchy leading to it.

pub fn parse_head(reader: &mut impl Read + Seek) -> Result<(usize, [u8; 4])>

Attempts to parse a 32 bit unsigned integer determining the size of the atom in bytes and the following 4 byte head from the reader.

pub fn parse_content(
    &mut self,
    reader: &mut impl Read + Seek,
    length: usize
) -> Result<()>

Attempts to parse the content of the provided length from the reader.

pub fn first_child(&self) -> Option<&Atom>

Attempts to return the first children atom if it's content is of type Content::Atoms.

pub fn mut_first_child(&mut self) -> Option<&mut Atom>

Attempts to return the first children atom if it's content is of type Content::Atoms.

pub fn is_valid_filetype(&self) -> bool

Return true if the filetype specified in the ftyp atom is valid, false otherwise.

pub fn filetype_atom() -> Atom

Returns a atom filetype hierarchy needed to parse the filetype:

pub fn metadata_atom() -> Atom

Returns a atom metadata hierarchy needed to parse metadata.

pub fn empty_metadata_atom() -> Atom

Returns a atom metadata hierarchy.

pub fn format_head(head: [u8; 4]) -> String

Returns the head formatted as a string.

Trait Implementations

impl Clone for Atom

fn clone(&self) -> Atom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Atom

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

Formats the value using the given formatter.

impl PartialEq<Atom> for Atom

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

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

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

This method tests for !=.