Enum flac_bound::FlacEncoderInitError

[−] Show declaration

[+] Expand attributes
#[repr(u32)]pub enum FlacEncoderInitError {
    EncoderError,
    UnsupportedContainer,
    InvalidCallbacks,
    InvalidNumberOfChannels,
    InvalidBitsPerSample,
    InvalidSampleRate,
    InvalidBlockSize,
    InvalidMaxLpcOrder,
    InvalidQlpCoeffPrecision,
    BlockSizeTooSmallForLpcOrder,
    NotStreamable,
    InvalidMetadata,
    AlreadyInitialized,
}

[−] Expand description

Possible erroneous return values for the FlacEncoderConfig::init_*() functions.

Variants

EncoderError

[−] Expand description

General failure to set up encoder; call FlacEncoder::state() for cause.

UnsupportedContainer

[−] Expand description

The library was not compiled with support for the given container format.

InvalidCallbacks

[−] Expand description

A required callback was not supplied.

InvalidNumberOfChannels

[−] Expand description

The encoder has an invalid setting for number of channels.

InvalidBitsPerSample

[−] Expand description

The encoder has an invalid setting for bits-per-sample.

FLAC supports 4-32 bps but the reference encoder currently supports only up to 24 bps.

InvalidSampleRate

[−] Expand description

The encoder has an invalid setting for the input sample rate.

InvalidBlockSize

[−] Expand description

The encoder has an invalid setting for the block size.

InvalidMaxLpcOrder

[−] Expand description

The encoder has an invalid setting for the maximum LPC order.

InvalidQlpCoeffPrecision

[−] Expand description

The encoder has an invalid setting for the precision of the quantized linear predictor coefficients.

BlockSizeTooSmallForLpcOrder

[−] Expand description

The specified block size is less than the maximum LPC order.

NotStreamable

[−] Expand description

The encoder is bound to the Subset but other settings violate it.

InvalidMetadata

[−] Expand description

The metadata input to the encoder is invalid, in one of the following ways:

• One of the metadata blocks contains an undefined type
• It contains an illegal CUESHEET as checked by FLAC__format_cuesheet_is_legal()
• It contains an illegal SEEKTABLE as checked by FLAC__format_seektable_is_legal()
• It contains more than one SEEKTABLE block or more than one VORBIS_COMMENT block

AlreadyInitialized

[−] Expand description

FlacEncoderConfig::init_*() was called when the encoder was already initialized, usually because FLAC__stream_encoder_finish() was not called.

Trait Implementations

impl Clone for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn clone(&self) -> FlacEncoderInitError[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for FlacEncoderInitError

impl Debug for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for FlacEncoderInitError

impl Hash for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given [Hasher].

impl Into<u32> for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn into(self) -> FLAC__StreamEncoderInitStatus[−]

Performs the conversion.

impl Ord for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &FlacEncoderInitError) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FlacEncoderInitError> for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn eq(&self, other: &FlacEncoderInitError) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialOrd<FlacEncoderInitError> for FlacEncoderInitError[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &FlacEncoderInitError) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for FlacEncoderInitError

impl StructuralPartialEq for FlacEncoderInitError

impl TryFrom<u32> for FlacEncoderInitError[+]

[+] Show hidden undocumented items

type Error = ()

The type returned in the event of a conversion error.

fn try_from(
    raw: FLAC__StreamEncoderInitStatus
) -> Result<FlacEncoderInitError, ()>[−]

Performs the conversion.