Enum ApiError 

pub enum ApiError {
    NetworkError(String),
    ParseError(String),
    SoapFault(u16),
    InvalidParameter(String),
    SubscriptionError(String),
    DeviceError(String),
}

High-level API errors for Sonos operations

This enum provides domain-specific error types that abstract away the underlying SOAP communication details and provide meaningful error information for common failure scenarios when controlling Sonos devices.

Variants

NetworkError(String)

Network communication error

This error occurs when there are network-level issues communicating with the device, such as connection timeouts, DNS resolution failures, or the device being unreachable.

ParseError(String)

Response parsing error

This error occurs when the device returns a valid response but the response content cannot be parsed into the expected format. This covers XML parsing errors, unexpected response formats, and event parsing issues.

SoapFault(u16)

SOAP fault returned by device

This error occurs when the device returns a SOAP fault response, indicating that the request was malformed or the operation failed.

InvalidParameter(String)

Invalid parameter value

This error is returned when an operation parameter has an invalid value. This covers volume out of range, invalid device states, malformed URLs, etc.

SubscriptionError(String)

Subscription operation failed

This error occurs when UPnP subscription operations (create, renew, unsubscribe) fail. This covers subscription failures, renewal failures, expired subscriptions, etc.

DeviceError(String)

Device operation error

This error covers device-specific issues like not being a group coordinator, unsupported operations, or invalid device states.

Implementations

impl ApiError

pub fn subscription_expired() -> Self

Create a subscription expired error (used by subscription management)

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<SoapError> for ApiError

Convert from SoapError to ApiError

fn from(error: SoapError) -> Self

Converts to this type from the input type.

impl From<ValidationError> for ApiError

Convert from ValidationError to ApiError

fn from(validation_error: ValidationError) -> Self

Converts to this type from the input type.