pubnub-core 0.1.0

//! Message and relevant types.

use super::channel;
use super::timetoken::Timetoken;
use json::JsonValue;

/// # PubNub Message
///
/// This is the message structure yielded by [`Subscription`].
///
/// [`Subscription`]: crate::Subscription
#[derive(Debug, Clone)]
pub struct Message {
    /// Enum Type of Message.
    pub message_type: Type,
    /// Wildcard channel or channel group.
    pub route: Option<channel::Name>,
    /// Origin Channel of Message Receipt.
    pub channel: channel::Name,
    /// Decoded JSON Message Payload.
    pub json: JsonValue,
    /// Metadata of Message.
    pub metadata: JsonValue,
    /// Message ID Timetoken.
    pub timetoken: Timetoken,
    /// Issuing client ID.
    pub client: Option<String>,
    /// Subscribe key associated with the message.
    pub subscribe_key: String,
    /// Message flags.
    pub flags: u32,
}

/// # PubNub Message Types
///
/// PubNub delivers multiple kinds of messages. This enumeration describes the various types
/// available.
///
/// The special `Unknown` variant may be delivered as the PubNub service evolves. It allows
/// applications built on the PubNub Rust client to be forward-compatible without requiring a full
/// client upgrade.
#[derive(Debug, Clone, Eq, PartialEq, Copy)]
pub enum Type {
    /// A class message containing arbitrary payload data.
    Publish,
    /// A Lightweight message.
    Signal,
    /// An Objects service event, like space description updated.
    Objects,
    /// A message action event.
    Action,
    /// Presence event from channel (e.g. another client joined).
    Presence,
    /// Unknown type. The value may have special meaning in some contexts.
    Unknown(u32),
}

impl Type {
    /// # Create a `MessageType` from an integer
    ///
    /// Subscribe message pyloads include a non-enumerated integer to describe message types. We
    /// instead provide a concrete type, using this function to convert the integer into the
    /// appropriate type.
    #[must_use]
    pub fn from_json(i: &JsonValue) -> Self {
        match i.as_u32().unwrap_or(0) {
            0 => Self::Publish,
            1 => Self::Signal,
            2 => Self::Objects,
            3 => Self::Action,
            i => Self::Unknown(i),
        }
    }
}

impl Default for Message {
    #[must_use]
    fn default() -> Self {
        Self {
            message_type: Type::Unknown(0),
            route: None,
            channel: channel::Name::default(),
            json: JsonValue::Null,
            metadata: JsonValue::Null,
            timetoken: Timetoken::default(),
            client: None,
            subscribe_key: String::default(),
            flags: Default::default(),
        }
    }
}