Enum ApiError

pub enum ApiError {
    Generic(String),
    MissingParameter,
    ClientMustUpgrade,
    ServerMustUpgrade,
    WrongAuth,
    Ldap,
    NotAuthorized(String),
    TrialExpired,
    NotFound,
}

The possible errors a Subsonic server may return.

Variants

Generic(String)

A generic error.

MissingParameter

A required parameter is missing.

ClientMustUpgrade

Incompatible REST protocol version. Client must upgrade.

ServerMustUpgrade

Incompatible REST protocol version. Server must upgrade.

WrongAuth

Wrong username or password.

Ldap

Token authentication is not supported for LDAP users.

NotAuthorized(String)

The user is not authorized for the given operation.

TrialExpired

The trial period for the Subsonic server is over.

Subsonic has a thirty day trial to use the software, including the REST API. Forks of Subsonic typically do not offer this support and should never return this error.

NotFound

The requested data was not found.

Implementations

impl ApiError

pub fn as_u16(&self) -> u16

Returns the code number of the error.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

Deserializes a serde_json::Value into an ApiError.

Expects a Subsonic error response; for example:

"error": {
  "code": 50,
  "message": "Permission denied for resource"
 }

fn deserialize<D>(de: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Fail for ApiError

fn name(&self) -> Option<&str>

Returns the “name” of the error.

fn cause(&self) -> Option<&dyn Fail>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

fn backtrace(&self) -> Option<&Backtrace>

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn context<D>(self, context: D) -> Context<D>

where D: Display + Send + Sync + 'static, Self: Sized,

Provides context for this failure.

fn compat(self) -> Compat<Self>

where Self: Sized,

Wraps this failure in a compatibility wrapper that implements std::error::Error.

impl From<ApiError> for Error

fn from(err: ApiError) -> Error

Converts to this type from the input type.