Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder {
    pub low: u64,
    pub range: u32,
    /* private fields */
}
Expand description

The binary range encoder.

Fields§

§low: u64

The low bound of the current interval.

§range: u32

The size of the current interval.

Implementations§

Source§

impl Encoder

Source

pub const TOP_VALUE: u32

The value above which the range is renormalised.

Source

pub fn new() -> Self

Creates an uninitialised encoder.

Source

pub fn set_stream(&mut self, stream: Vec<u8>)

Replaces the output buffer.

Source

pub fn release_stream(&mut self) -> Vec<u8> ⓘ

Takes the output buffer out of the encoder.

Source

pub fn stream(&self) -> &[u8] ⓘ

The bytes written so far.

Source

pub fn stream_mut(&mut self) -> &mut Vec<u8> ⓘ

The bytes written so far, mutably.

Source

pub fn init(&mut self)

Initialises the encoder for a new stream.

Source

pub fn flush_data(&mut self)

Flushes the pending low bytes.

Source

pub fn flush_stream(&mut self)

Flushes the output stream.

Does nothing, since a Vec<u8> has nothing to flush.

Source

pub fn close_stream(&mut self)

Closes the output stream.

Drops the output buffer.

Source

pub fn encode(&mut self, start: u32, size: u32, total: u32)

Encodes a symbol that occupies size of total probability units.

Source

pub fn shift_low(&mut self)

Shifts the low accumulator by one byte, emitting the pending bytes.

Source

pub fn encode_direct_bits(&mut self, v: u32, num_total_bits: i32)

Encodes num_total_bits bits of v without a probability model.

Source

pub fn encode_bit(&mut self, size0: u32, num_total_bits: i32, symbol: u32)

Encodes a single bit using a probability model of num_total_bits bits.

Source

pub fn get_processed_size_add(&self) -> i64

The number of bytes produced so far, plus the four bytes that the decoder needs to finish the stream.

Trait Implementations§

Source§

impl Clone for Encoder

Source§

fn clone(&self) -> Self

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 Encoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Encoder

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more