Struct Page

pub struct Page {
    pub end: u64,
    /* private fields */
}

An OGG page

Fields

end: u64

The position in the stream the page ended

Implementations

impl Page

pub fn header(&self) -> &PageHeader

Returns a reference to the Page’s header

pub fn header_mut(&mut self) -> &mut PageHeader

Returns a mutable reference to the Page’s header

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

Convert the Page to bytes for writing

NOTE: This will write the checksum as is. It is likely Page::gen_crc will have to be used prior.

pub fn read<V>(data: &mut V) -> Result<Self>

where V: Read + Seek,

Attempts to get a Page from a reader

Errors

• std::io::Error
• PageError

pub fn gen_crc(&mut self)

Generates the CRC checksum of the page

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

Returns the page’s content

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

Consumes the page and returns its content

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Page

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

Formats the value using the given formatter.

impl PartialEq for Page

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Page

impl StructuralPartialEq for Page