Struct sqlib::channel::Channel

pub struct Channel {
    pub cid: i64,
    pub channel_name: String,
    pub clients: Vec<Client>,
}

Channel contains a TeamSpeak 3 channel.

Example

use sqlib::channel;

let channel = sqlib::channel::Channel::new(0, "test".to_string());

assert!(channel.is_empty());
assert_eq!("test".to_string(), format!("{}", channel));

Fields

cid: i64

channel id

channel_name: String

channel name

clients: Vec<Client>

A vector of clients, who are in the channel.

Implementations

impl Channel

pub fn new(channel_id: i64, name: String) -> Channel

Create an empty Channel from a channel id and a name.

pub fn from_map(map: &StringMap) -> Channel

Create a new Channel from a given map.

pub fn update_from_map(channel: &Channel, map: &StringMap) -> Channel

Create a new Channel from a given Channel and a map.

pub fn mut_from_map(&mut self, map: &StringMap)

Mutate self from a given map.

pub fn is_empty(&self) -> bool

pub fn clients_len(&self) -> usize

pub fn add_client(&mut self, client: Client)

pub fn sort_clients(&mut self)

pub fn remove_sq_clients(&mut self)

Remove all Server Query Clients from the Channel.

pub fn as_json(&self) -> String

Creates a JSON String from self.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy 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 Decodable for Channel

fn decode<__D: Decoder>(d: &mut __D) -> Result<Channel, __D::Error>

Deserialize a value using a Decoder.

impl Default for Channel

fn default() -> Channel

Returns the “default value” for a type.

impl Display for Channel

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

Formats the value using the given formatter.

impl Encodable for Channel

fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>

Serialize a value using an Encoder.

impl FromStr for Channel

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Ord for Channel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Channel> for Channel

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Channel> for Channel

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Channel