twilight-model 0.15.0-rc.1

Discord API models for the Twilight ecosystem.
Documentation
use crate::gateway::{
    opcode::OpCode,
    presence::{Activity, Status},
};
use serde::{Deserialize, Serialize};
use std::{
    error::Error,
    fmt::{Display, Formatter, Result as FmtResult},
};

/// Error emitted when the payload can not be created as configured.
#[derive(Debug)]
pub struct UpdatePresenceError {
    kind: UpdatePresenceErrorType,
}

impl UpdatePresenceError {
    /// Immutable reference to the type of error that occurred.
    #[must_use = "retrieving the type has no effect if let unused"]
    pub const fn kind(&self) -> &UpdatePresenceErrorType {
        &self.kind
    }

    /// Consume the error, returning the source error if there is any.
    #[allow(clippy::unused_self)]
    #[must_use = "consuming the error and retrieving the source has no effect if let unused"]
    pub fn into_source(self) -> Option<Box<dyn Error + Send + Sync>> {
        None
    }

    /// Consume the error, returning the owned error type and the source error.
    #[must_use = "consuming the error into its parts has no effect if left unused"]
    pub fn into_parts(
        self,
    ) -> (
        UpdatePresenceErrorType,
        Option<Box<dyn Error + Send + Sync>>,
    ) {
        (self.kind, None)
    }
}

impl Display for UpdatePresenceError {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self.kind {
            UpdatePresenceErrorType::MissingActivity => {
                f.write_str("at least one activity must be provided")
            }
        }
    }
}

impl Error for UpdatePresenceError {}

/// Type of [`UpdatePresenceError`] that occurred.
#[derive(Debug)]
#[non_exhaustive]
pub enum UpdatePresenceErrorType {
    /// No activities provided.
    MissingActivity,
}

#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct UpdatePresence {
    pub d: UpdatePresencePayload,
    pub op: OpCode,
}

impl UpdatePresence {
    /// Create a new, valid [`UpdatePresence`] payload.
    ///
    /// # Errors
    ///
    /// Returns an error of type [`UpdatePresenceErrorType::MissingActivity`] if
    /// an empty set of activities is provided.
    pub fn new(
        activities: impl Into<Vec<Activity>>,
        afk: bool,
        since: impl Into<Option<u64>>,
        status: impl Into<Status>,
    ) -> Result<Self, UpdatePresenceError> {
        let d = UpdatePresencePayload::new(activities, afk, since, status)?;

        Ok(Self {
            d,
            op: OpCode::PresenceUpdate,
        })
    }
}

#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct UpdatePresencePayload {
    /// User's activities.
    ///
    /// At least one is required.
    pub activities: Vec<Activity>,
    pub afk: bool,
    pub since: Option<u64>,
    pub status: Status,
}

impl UpdatePresencePayload {
    /// Create a validated stats update info struct.
    ///
    /// # Errors
    ///
    /// Returns an [`UpdatePresenceErrorType::MissingActivity`] error type if an
    /// empty set of activities is provided.
    pub fn new(
        activities: impl Into<Vec<Activity>>,
        afk: bool,
        since: impl Into<Option<u64>>,
        status: impl Into<Status>,
    ) -> Result<Self, UpdatePresenceError> {
        Self::_new(activities.into(), afk, since.into(), status.into())
    }

    fn _new(
        activities: Vec<Activity>,
        afk: bool,
        since: Option<u64>,
        status: Status,
    ) -> Result<Self, UpdatePresenceError> {
        if activities.is_empty() {
            return Err(UpdatePresenceError {
                kind: UpdatePresenceErrorType::MissingActivity,
            });
        }

        Ok(Self {
            activities,
            afk,
            since,
            status,
        })
    }
}