Struct SpeexBits 

pub struct SpeexBits<'a> {
    pub buffer_ref: Option<&'a mut [u8]>,
    /* private fields */
}

A struct that holds bits to be read or written to

Internally packs bits.

Fields

buffer_ref: Option<&'a mut [u8]>

Implementations

impl<'a> SpeexBits<'a>

pub fn new() -> Self

Creates a new SpeexBits

pub fn buffer<'b>(&mut self) -> &'a mut [u8]

pub fn new_with_buffer(buffer: &'a mut [u8]) -> Self

Creates a new SpeexBits with an existing buffer

pub fn advance(&mut self, n: i32)

Advances the read pointer by n bits

pub fn insert_terminator(&mut self)

Inserts a terminator so the data can be sent as a packet while autodetecting how many frames were in the packet

pub fn num_bytes(&mut self) -> i32

Returns the number of bytes in the bitstream, including the last partial byte

pub fn pack(&mut self, data: i32, num_bits: i32)

Appends bits to the bitstream

pub fn peek(&mut self) -> i32

Gets the value of the next bit in the stream without advancing the read pointer

pub fn peek_unsigned(&mut self, num_bits: i32) -> u32

Gets the value of the next num_bits in the stream without advancing the read pointer

pub fn read_from(&mut self, buffer: &mut [u8])

pub fn read_whole_bytes(&mut self, bytes: &[u8])

Appends bytes to the bitstream

pub fn remaining(&mut self) -> u32

Returns the number of bits remaining to be read from a stream

pub fn reset(&mut self)

Resets SpeexBits to the initial state, erasing all content

pub fn rewind(&mut self)

Resets the read pointer to the beginning, without erasing the content

pub fn set_bit_buffer(&mut self, buffer: &mut [u8])

Sets an existing SpeexBits to use data from an existing buffer

pub fn unpack_signed(&mut self, num_bits: i32) -> i32

Interpret the next number of bits as a signed integer, advancing the read pointer

pub fn unpacked_unsigned(&mut self, num_bits: i32) -> u32

Interpret the next number of bits as an unsigned integer, advancing the read pointer

pub fn write(&mut self, buffer: &mut [u8]) -> u32

Writes the content of the bitstream to a buffer

pub fn write_whole_bytes(&mut self, buffer: &mut [u8]) -> u32

Writes the content of the bitstream to a buffer, writing whole bytes only. Removes any bytes that are successfully written from the bitstream.

Trait Implementations

impl<'a> Default for SpeexBits<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Drop for SpeexBits<'a>

fn drop(&mut self)

Executes the destructor for this type.