Struct ogg_pager::PageHeader

pub struct PageHeader {
    pub start: u64,
    pub abgp: u64,
    pub stream_serial: u32,
    pub sequence_number: u32,
    /* private fields */
}

An OGG page header

Fields

start: u64

The position in the stream the page started at

abgp: u64

The page’s absolute granule position

stream_serial: u32

The page’s stream serial number

sequence_number: u32

The page’s sequence number

Implementations

impl PageHeader

pub const fn new(
    header_type_flag: u8,
    abgp: u64,
    stream_serial: u32,
    sequence_number: u32
) -> Self

Creates a new PageHeader

pub fn read<R>(data: &mut R) -> Result<Self>where
    R: Read + Seek,

Reads a PageHeader from a reader

Errors

• PageError::MissingMagic
• PageError::InvalidVersion
• PageError::BadSegmentCount
• Reader does not have enough data

pub fn content_size(&self) -> usize

Returns the size of the page content, excluding the header

pub fn header_type_flag(&self) -> u8

Returns the page’s header type flag

pub fn checksum(&self) -> u32

Returns the page’s checksum

Trait Implementations

impl Clone for PageHeader

fn clone(&self) -> PageHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageHeader

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

Formats the value using the given formatter.

impl PartialEq<PageHeader> for PageHeader

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PageHeader

impl StructuralEq for PageHeader

impl StructuralPartialEq for PageHeader