Struct SHErrorCode 

#[repr(transparent)]
pub struct SHErrorCode(pub NSInteger);

Available on crate feature SHError only.

An error type that you create, or the system creates, to indicate problems with a catalog, match attempt, or signature, or when saving to a user’s Shazam library.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl SHErrorCode

pub const InvalidAudioFormat: Self

The error code to indicate an unsupported audio format.

For the list of the supported audio formats, see SHSignatureGenerator/append(_:at:).

pub const AudioDiscontinuity: Self

The error code to indicate the use of noncontiguous audio to request a match.

pub const SignatureInvalid: Self

The error code to indicate that the system is unable to generate a signature from the audio.

The most common cause of this error is silent audio input.

pub const SignatureDurationInvalid: Self

The error code to indicate that the length of the generated signature is too long or too short to make a match in the catalog.

This error occurs when the length of the generated signature is less than SHCatalog/minimumQuerySignatureDuration or greater than SHCatalog/maximumQuerySignatureDuration for the session SHSession/catalog.

pub const MatchAttemptFailed: Self

The error code to indicate when a Shazam Music catalog server issue prevents finding a match.

pub const CustomCatalogInvalid: Self

The error code to indicate when the custom catalog fails to load due to an invalid format.

pub const CustomCatalogInvalidURL: Self

The error code to indicate that the format for the custom catalog URL is invalid.

pub const MediaLibrarySyncFailed: Self

The error code that indicates when the system fails to add media items to or remove items from the user’s Shazam library.

pub const InternalError: Self

The error code to indicate a generic framework error.

pub const MediaItemFetchFailed: Self

The error code to indicate when the system fails to fetch one or more media items.

Trait Implementations

impl Clone for SHErrorCode

fn clone(&self) -> SHErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SHErrorCode

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

Formats the value using the given formatter.

impl Encode for SHErrorCode

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for SHErrorCode

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SHErrorCode

fn cmp(&self, other: &SHErrorCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SHErrorCode

fn eq(&self, other: &SHErrorCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SHErrorCode

fn partial_cmp(&self, other: &SHErrorCode) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl RefEncode for SHErrorCode

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for SHErrorCode

impl Eq for SHErrorCode

impl StructuralPartialEq for SHErrorCode