Struct Channel 

pub struct Channel {
    pub channel_type: ChannelType,
    pub identifier: String,
    pub filter: Option<String>,
}

A channel that clients can subscribe to.

Fields

channel_type: ChannelType

Channel type.

identifier: String

Channel identifier.

filter: Option<String>

Optional sub-channel filter.

Implementations

impl Channel

pub fn parse(s: &str) -> Result<Self, RealtimeError>

Parse a channel string into a Channel.

Formats:

• repo:owner/name - All events for a repository
• repo:owner/name/prs - PR events only
• repo:owner/name/issues - Issue events only
• user:username - User notifications
• org:orgname - Organization events

pub fn matches(&self, event_channel: &str) -> bool

Check if an event channel matches this subscription channel.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Channel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Channel

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

Formats the value using the given formatter.

impl Hash for Channel

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Channel

fn eq(&self, other: &Channel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Channel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Channel

impl StructuralPartialEq for Channel