f222ce9969
Main goal: a lot of nested future/result folding. This mainly modifies error handling for Tracks and TrackHandles to be more consistent, and hides the underlying channel result passing in get_info. Errors returned should be far clearer, and are domain specific rather than falling back to a very opaque use of the underlying channel error. It should be clearer to users why their handle commands failed, or why they can't make a ytdl track loop or similar. Also fixed/cleaned up Songbird::join(_gateway) to return in a single await, sparing the user from the underlying channel details and repeated Errs. I was trying for some time to extend the same graces to `Call`, but could not figure out a sane way to get a 'static version of the first future in the chain (i.e., the gateway send) so that the whole thing could happen after dropping the lock around the Call. I really wanted to fix this to happen as a single folded await too, but I think this might need some crazy hack or redesign.
111 lines
3.7 KiB
Rust
111 lines
3.7 KiB
Rust
//! Connection errors and convenience types.
|
|
|
|
use crate::{
|
|
driver::tasks::{error::Recipient, message::*},
|
|
ws::Error as WsError,
|
|
};
|
|
use flume::SendError;
|
|
use serde_json::Error as JsonError;
|
|
use std::{error::Error as ErrorTrait, fmt, io::Error as IoError};
|
|
use xsalsa20poly1305::aead::Error as CryptoError;
|
|
|
|
/// Errors encountered while connecting to a Discord voice server over the driver.
|
|
#[derive(Debug)]
|
|
#[non_exhaustive]
|
|
pub enum Error {
|
|
/// The driver hung up an internal signaller, either due to another connection attempt
|
|
/// or a crash.
|
|
AttemptDiscarded,
|
|
/// An error occurred during [en/de]cryption of voice packets or key generation.
|
|
Crypto(CryptoError),
|
|
/// Server did not return the expected crypto mode during negotiation.
|
|
CryptoModeInvalid,
|
|
/// Selected crypto mode was not offered by server.
|
|
CryptoModeUnavailable,
|
|
/// An indicator that an endpoint URL was invalid.
|
|
EndpointUrl,
|
|
/// Discord hello/ready handshake was violated.
|
|
ExpectedHandshake,
|
|
/// Discord failed to correctly respond to IP discovery.
|
|
IllegalDiscoveryResponse,
|
|
/// Could not parse Discord's view of our IP.
|
|
IllegalIp,
|
|
/// Miscellaneous I/O error.
|
|
Io(IoError),
|
|
/// JSON (de)serialization error.
|
|
Json(JsonError),
|
|
/// Failed to message other background tasks after connection establishment.
|
|
InterconnectFailure(Recipient),
|
|
/// Error communicating with gateway server over WebSocket.
|
|
Ws(WsError),
|
|
}
|
|
|
|
impl From<CryptoError> for Error {
|
|
fn from(e: CryptoError) -> Self {
|
|
Error::Crypto(e)
|
|
}
|
|
}
|
|
|
|
impl From<IoError> for Error {
|
|
fn from(e: IoError) -> Error {
|
|
Error::Io(e)
|
|
}
|
|
}
|
|
|
|
impl From<JsonError> for Error {
|
|
fn from(e: JsonError) -> Error {
|
|
Error::Json(e)
|
|
}
|
|
}
|
|
|
|
impl From<SendError<WsMessage>> for Error {
|
|
fn from(_e: SendError<WsMessage>) -> Error {
|
|
Error::InterconnectFailure(Recipient::AuxNetwork)
|
|
}
|
|
}
|
|
|
|
impl From<SendError<EventMessage>> for Error {
|
|
fn from(_e: SendError<EventMessage>) -> Error {
|
|
Error::InterconnectFailure(Recipient::Event)
|
|
}
|
|
}
|
|
|
|
impl From<SendError<MixerMessage>> for Error {
|
|
fn from(_e: SendError<MixerMessage>) -> Error {
|
|
Error::InterconnectFailure(Recipient::Mixer)
|
|
}
|
|
}
|
|
|
|
impl From<WsError> for Error {
|
|
fn from(e: WsError) -> Error {
|
|
Error::Ws(e)
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for Error {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
write!(f, "Failed to connect to Discord RTP server: ")?;
|
|
use Error::*;
|
|
match self {
|
|
AttemptDiscarded => write!(f, "connection attempt was aborted/discarded."),
|
|
Crypto(c) => write!(f, "cryptography error {}.", c),
|
|
CryptoModeInvalid => write!(f, "server changed negotiated encryption mode."),
|
|
CryptoModeUnavailable => write!(f, "server did not offer chosen encryption mode."),
|
|
EndpointUrl => write!(f, "endpoint URL received from gateway was invalid."),
|
|
ExpectedHandshake => write!(f, "voice initialisation protocol was violated."),
|
|
IllegalDiscoveryResponse =>
|
|
write!(f, "IP discovery/NAT punching response was invalid."),
|
|
IllegalIp => write!(f, "IP discovery/NAT punching response had bad IP value."),
|
|
Io(i) => write!(f, "I/O failure ({}).", i),
|
|
Json(j) => write!(f, "JSON (de)serialization issue ({}).", j),
|
|
InterconnectFailure(r) => write!(f, "failed to contact other task ({:?})", r),
|
|
Ws(w) => write!(f, "websocket issue ({:?}).", w),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ErrorTrait for Error {}
|
|
|
|
/// Convenience type for Discord voice/driver connection error handling.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|