Struct Encoder

#[non_exhaustive]
pub struct Encoder {
    pub block_size: usize,
    pub multithread: bool,
    pub workers: Option<NonZeroUsize>,
    pub stereo_coding: StereoCoding,
    pub subframe_coding: SubFrameCoding,
}

Configuration for encoder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

block_size: usize

Encoder block size (default: constant::DEFAULT_BLOCK_SIZE)

multithread: bool

Whether encoder runs on multi-thread mode. (default: true when "par" feature is used)

workers: Option<NonZeroUsize>

The number of threads used in multithread mode. (default: None)

If None, the number of workers is set to be identical with the number of the logical CPU cores in the running environment.

stereo_coding: StereoCoding

Configuration for stereo-coding module.

subframe_coding: SubFrameCoding

Configuration for individual channels.

Trait Implementations

impl Clone for Encoder

fn clone(&self) -> Encoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Encoder

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

Formats the value using the given formatter.

impl Default for Encoder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Encoder

where Encoder: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Encoder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Verify for Encoder

fn verify(&self) -> Result<(), VerifyError>

Verifies there’s no internal data inconsistency.

fn into_verified(self) -> Result<Verified<Self>, (Self, VerifyError)>

Wraps into Verified to indicate that the data is already verified.

unsafe fn assume_verified(self) -> Verified<Self>

Wraps into Verified without actual verification.