Struct ogg_pager::Page

pub struct Page {
    pub abgp: u64,
    pub serial: u32,
    pub seq_num: u32,
    pub start: u64,
    pub end: u64,
    // some fields omitted
}

An OGG page

Fields

abgp: u64

The page’s absolute granule position

serial: u32

The page’s stream serial number

seq_num: u32

The page’s sequence number

start: u64

The position in the stream the page started at

end: u64

The position in the stream the page ended

Implementations

impl Page

pub fn new(
    header_type_flag: u8,
    abgp: u64,
    stream_serial: u32,
    sequence_number: u32,
    content: Vec<u8>
) -> Result<Self>

Create a new Page

This will have the following defaults:

• checksum = 0
• start = 0
• end = content.len()

Errors

See segment_table

Example

use ogg_pager::CONTAINS_FIRST_PAGE_OF_BITSTREAM;

// Creating the identification header
let ident_header_packet = vec![...];
let stream_serial_number = 2784419176;

let page = Page::new(
    CONTAINS_FIRST_PAGE_OF_BITSTREAM,
    0,
    stream_serial_number,
    ident_header_packet,
);

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

Convert the Page to Vec 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, skip_content: bool) -> Result<Self> where
    V: Read + Seek, 

Attempts to get a Page from a reader

Use skip_content to only read the header, and skip over the content.

Errors

• std::io::Error
• PageError

pub fn gen_crc(&mut self)

Generates the CRC checksum of the page

pub fn extend(&mut self, content: &[u8]) -> Option<Page>

Extends the Page’s content, returning another Page if too much data was provided

This will do nothing if content is greater than the max page size. In this case, paginate should be used.

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

Returns the page’s content

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

Consumes the page and returns it’s content

pub fn header_type(&self) -> u8

Returns the page’s header type flag

pub fn checksum(&self) -> u32

Returns the page’s checksum

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

Returns the page’s segment table

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a copy 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<Page> for Page

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

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

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

This method tests for !=.

impl StructuralPartialEq for Page