Connection

Struct Connection 

Source
pub struct Connection<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> Connection<'a>

Source

pub fn get_uid(&self) -> Result<&str, Error>

Source

pub fn get_name(&self) -> Result<&str, Error>

Source

pub fn get_talking(&self) -> Result<TalkStatus, Error>

Source

pub fn get_whispering(&self) -> Result<bool, Error>

Source

pub fn get_away(&self) -> Result<AwayStatus, Error>

Source

pub fn get_away_message(&self) -> Result<&str, Error>

Source

pub fn get_input_muted(&self) -> Result<MuteInputStatus, Error>

Source

pub fn get_output_muted(&self) -> Result<MuteOutputStatus, Error>

Source

pub fn get_output_only_muted(&self) -> Result<MuteOutputStatus, Error>

Source

pub fn get_input_hardware(&self) -> Result<HardwareInputStatus, Error>

Source

pub fn get_output_hardware(&self) -> Result<HardwareOutputStatus, Error>

Source

pub fn get_phonetic_name(&self) -> Result<&str, Error>

Source

pub fn get_recording(&self) -> Result<bool, Error>

Source

pub fn get_database_id(&self) -> Result<u64, Error>

Only valid data if we have the appropriate permissions.

Source

pub fn get_channel_group_id(&self) -> Result<ChannelGroupId, Error>

Source

pub fn get_server_groups(&self) -> Result<&Vec<ServerGroupId>, Error>

Source

pub fn get_talk_power(&self) -> Result<i32, Error>

Source

pub fn get_talk_request(&self) -> Result<DateTime<Utc>, Error>

Source

pub fn get_talk_request_message(&self) -> Result<&str, Error>

Source

pub fn get_server_ip(&self) -> Result<&str, Error>

Only available for oneself

Source

pub fn get_server_port(&self) -> Result<u16, Error>

Only available for oneself

Source

pub fn get_input_deactivated(&self) -> Result<InputDeactivationStatus, Error>

Only available for oneself

Source

pub fn get_default_channel(&self) -> Result<ChannelId, Error>

Only available for oneself

Source

pub fn get_default_token(&self) -> Result<&str, Error>

Only available for oneself

Source

pub fn get_login_name(&self) -> Result<&str, Error>

Only available for server queries

Source

pub fn get_login_password(&self) -> Result<&str, Error>

Only available for server queries

Source

pub fn get_version(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_platform(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_created(&self) -> Result<DateTime<Utc>, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_last_connected(&self) -> Result<DateTime<Utc>, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_total_connections(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_ping(&self) -> Result<Duration, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_ping_deviation(&self) -> Result<Duration, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_connected_time(&self) -> Result<Duration, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_idle_time(&self) -> Result<Duration, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_client_ip(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_client_port(&self) -> Result<u16, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_sent_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_sent_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_sent_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_sent_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_sent_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_sent_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_sent_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_sent_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_received_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_received_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_received_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packets_received_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_received_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_received_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_received_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bytes_received_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packetloss_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packetloss_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packetloss_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_packetloss_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_server_to_client_packetloss_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_server_to_client_packetloss_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_server_to_client_packetloss_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_server_to_client_packetloss_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_client_to_server_packetloss_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_client_to_server_packetloss_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_client_to_server_packetloss_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_client_to_server_packetloss_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_second_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_second_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_second_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_second_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_minute_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_minute_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_minute_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_sent_last_minute_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_second_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_second_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_second_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_second_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_minute_speech(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_minute_keepalive(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_minute_control(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_bandwidth_received_last_minute_total(&self) -> Result<u64, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_month_bytes_uploaded(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_month_bytes_downloaded(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_total_bytes_uploaded(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_total_bytes_downloaded(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_default_channel_password(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_server_password(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_is_muted(&self) -> Result<bool, Error>

If the client is locally muted.

Only available if requested explicitly through request_data.

Source

pub fn get_volume_modificator(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_version_sign(&self) -> Result<bool, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_avatar(&self) -> Result<bool, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_description(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_talker(&self) -> Result<bool, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_priority_speaker(&self) -> Result<bool, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_unread_messages(&self) -> Result<bool, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_needed_serverquery_view_power(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_icon_id(&self) -> Result<i32, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_is_channel_commander(&self) -> Result<bool, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_country(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_badges(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_myteamspeak_id(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_integrations(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn get_active_integrations_info(&self) -> Result<&str, Error>

Only available if requested explicitly through request_data.

Source

pub fn properties(&self) -> Vec<ConnectionProperty<'_>>

Source§

impl<'a> Connection<'a>

Source

pub fn get_id(&self) -> ConnectionId

Source

pub fn get_server(&self) -> Server<'a>

Get the server of this connection.

Source

pub fn get_channel(&self) -> Result<Channel<'a>, Error>

Get the channel of this connection.

Source

pub fn get_channel_group_inherited_channel(&self) -> Result<Channel<'a>, Error>

Source

pub fn send_message<S: AsRef<str>>(&self, message: S) -> Result<(), Error>

Send a private message to this connection.

Trait Implementations§

Source§

impl<'a> Clone for Connection<'a>

Source§

fn clone(&self) -> Connection<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Connection<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, 'b> PartialEq<Connection<'b>> for Connection<'a>

Source§

fn eq(&self, other: &Connection<'b>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a> Eq for Connection<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Connection<'a>

§

impl<'a> RefUnwindSafe for Connection<'a>

§

impl<'a> Send for Connection<'a>

§

impl<'a> Sync for Connection<'a>

§

impl<'a> Unpin for Connection<'a>

§

impl<'a> UnwindSafe for Connection<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.