Struct ogg_magic::ogg_vorbis_page::OggVorbisPage

pub struct OggVorbisPage {
    pub ogg_page: OggPage,
}

Represents an Ogg Vorbis page.

Fields

ogg_page: OggPage

Implementations

impl OggVorbisPage

pub fn new(buffer: Vec<u8>) -> Result<Self, VorbisFormatError>

Creates a new OggVorbisPage from the given buffer.

pub fn get_identification( &self, segment_index: usize, ) -> Result<IVorbisIdentificationHeader, VorbisFormatError>

Retrieves the identification header from the specified segment index.

pub fn is_header_packet(&self, segment_index: usize) -> bool

Checks if the specified segment is a header packet.

pub fn is_identification_packet(&self, segment_index: usize) -> bool

Checks if the specified segment is an identification packet.

pub fn is_comment_packet(&self, segment_index: usize) -> bool

Checks if the specified segment is a comment packet.

pub fn is_setup_packet(&self, segment_index: usize) -> bool

Checks if the specified segment is a setup packet.

pub fn get_comments( &self, segment_index: usize, ) -> Result<IVorbisCommentHeader, VorbisFormatError>

Retrieves the comments from the specified segment index.

pub fn get_setup( &self, audio_channels: u8, segment_index: usize, ) -> Result<IVorbisSetupHeader, VorbisFormatError>

Retrieves the setup header from the specified segment index.

pub fn remove_page_segment( &self, index: usize, n: usize, ) -> Result<Self, VorbisFormatError>

pub fn replace_page_segment( &self, segment: Vec<u8>, index: usize, ) -> Result<Self, VorbisFormatError>

pub fn build_comments(header: IVorbisCommentHeader) -> Vec<u8>

Methods from Deref<Target = OggPage>

pub fn validate_page_size(&self) -> Result<(), OggFormatError>

Validates the size of the Ogg page.

Returns

• Result<(), OggFormatError> - Ok if the size is valid, otherwise an error.

pub fn get_page_segment(&self, index: usize) -> Result<Vec<u8>, OggFormatError>

Retrieves a specific segment from the Ogg page.

Arguments

• index - The index of the segment to retrieve.

Returns

• Result<Vec<u8>, OggFormatError> - The segment as a vector of bytes or an error if the index is out of range.

pub fn map_segments<T, F>(&self, callback: F) -> Vec<T>

where F: Fn(&[u8], usize) -> T,

Applies a callback function to each segment of the Ogg page.

Arguments

• callback - A function to apply to each segment.

Returns

• Vec<T> - A vector containing the results of applying the callback to each segment.

pub fn remove_page_segment_and_get_raw_result( &self, index: usize, n: usize, ) -> Result<Vec<u8>, OggFormatError>

Removes a segment from the Ogg page and returns the raw result.

Arguments

• index - The starting index of the segment to remove.
• n - The number of segments to remove.

Returns

• Result<Vec<u8>, OggFormatError> - The new buffer as a vector of bytes or an error if the operation fails.

pub fn add_page_segment_and_get_raw_result( &self, segments: &[Vec<u8>], index: usize, ) -> Result<Vec<u8>, OggFormatError>

Adds segments to the Ogg page and returns the raw result.

Arguments

• segments - A slice of vectors, each representing a segment to add.
• index - The index at which to add the segments.

Returns

• Result<Vec<u8>, OggFormatError> - The new buffer as a vector of bytes or an error if the operation fails.

pub fn replace_page_segment_and_get_raw_result( &self, segment: Vec<u8>, index: usize, ) -> Result<Vec<u8>, OggFormatError>

Replaces a segment in the Ogg page and returns the raw result.

Arguments

• segment - A vector of bytes representing the new segment.
• index - The index of the segment to replace.

Returns

• Result<Vec<u8>, OggFormatError> - The new buffer as a vector of bytes or an error if the operation fails.

pub fn remove_page_segment( &self, index: usize, n: usize, ) -> Result<Self, OggFormatError>

Removes a segment from the Ogg page.

Arguments

• index - The starting index of the segment to remove.
• n - The number of segments to remove.

Returns

• Result<Self, OggFormatError> - A new OggPage instance or an error if the operation fails.

pub fn add_page_segment( &self, segments: &[Vec<u8>], index: usize, ) -> Result<Self, OggFormatError>

Adds segments to the Ogg page.

Arguments

• segments - A slice of vectors, each representing a segment to add.
• index - The index at which to add the segments.

Returns

• Result<Self, OggFormatError> - A new OggPage instance or an error if the operation fails.

pub fn replace_page_segment( &self, segment: Vec<u8>, index: usize, ) -> Result<Self, OggFormatError>

Replaces a segment in the Ogg page.

Arguments

• segment - A vector of bytes representing the new segment.
• index - The index of the segment to replace.

Returns

• Result<Self, OggFormatError> - A new OggPage instance or an error if the operation fails.

pub fn calculate_page_checksum(&self) -> u32

Calculates the checksum of the Ogg page.

Returns

• u32 - The calculated checksum.

pub fn update_page_checksum(&mut self)

Updates the checksum of the Ogg page.

pub fn if_page_checksum_correct(&self) -> bool

Checks if the checksum of the Ogg page is correct.

Returns

• bool - true if the checksum is correct, false otherwise.

Trait Implementations

impl Clone for OggVorbisPage

fn clone(&self) -> OggVorbisPage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OggVorbisPage

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

Formats the value using the given formatter.

impl DerefMut for OggVorbisPage

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Deref for OggVorbisPage

type Target = OggPage

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.