Skip to main content

PageWriter

Struct PageWriter 

Source
pub struct PageWriter { /* private fields */ }
Expand description

Builds Ogg pages for one logical bitstream.

Packets are appended with push; pages are emitted into an output buffer when full (255 segments) or when explicitly flushed. The writer maintains the sequence numbers and the continued/bos/eos flags.

Implementations§

Source§

impl PageWriter

Source

pub const fn new(serial: u32) -> Self

Creates a writer for a logical bitstream with the given serial number.

Source

pub fn push( &mut self, out: &mut Vec<u8>, packet: &[u8], granule_position: u64, end_of_stream: bool, )

Appends one packet, emitting full pages into out as needed.

granule_position is the codec-defined position as of the end of this packet; it is recorded on the page where the packet completes (RFC 7845 §4: the page granule belongs to the last packet completed on it). When end_of_stream is set, the page the packet completes on is flagged EOS and flushed immediately.

Source

pub fn flush(&mut self, out: &mut Vec<u8>)

Emits the partially filled page, if any.

RFC 7845 §3 requires the ID header to sit alone on the first page and the comment header to finish its final page; call this after each.

Trait Implementations§

Source§

impl Clone for PageWriter

Source§

fn clone(&self) -> PageWriter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PageWriter

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.