Struct mp4ameta::Atom

pub struct Atom {
    pub ident: Ident,
    pub offset: usize,
    pub content: Content,
}

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

Fields

ident: Ident

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.

Implementations

impl Atom

pub fn with(ident: Ident, offset: usize, content: Content) -> Self

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

pub fn with_raw_data(ident: Ident, offset: usize, data: Data) -> Self

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

pub fn with_typed_data(ident: Ident, offset: usize, data: Data) -> Self

Creates an atom with the identifier, containing Content::TypedData with the provided data.

pub fn data_atom_with(data: Data) -> Self

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

pub fn len(&self) -> usize

Returns the length of the atom in bytes.

pub fn is_empty(&self) -> bool

Returns true if the atom has no offset or content and only consists of it's 8 byte head.

pub fn child(&self, ident: Ident) -> Option<&Self>

Returns a reference to the first children atom matching the identifier, if present.

pub fn mut_child(&mut self, ident: Ident) -> Option<&mut Self>

Returns a mutable reference to the first children atom matching the identifier, if present.

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

Return a reference to the first children atom, if present.

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

Returns a mutable reference to the first children atom, if present.

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

Attempts to write the atom to the writer.

pub fn check_filetype(&self) -> Result<()>

Checks if the filetype is valid, returns an error otherwise.

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: &Atom) -> bool

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

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

This method tests for !=.

impl StructuralPartialEq for Atom