Struct ts3_query::QueryClient

pub struct QueryClient { /* fields omitted */ }

Ts3 Query client with active connection

Implementations

impl QueryClient

pub fn new<A: ToSocketAddrs>(addr: A) -> Result<Self, Ts3Error>

Create new query connection

pub fn with_timeout<A: ToSocketAddrs>(
    addr: A,
    t_connect: Option<Duration>,
    timeout: Option<Duration>
) -> Result<Self, Ts3Error>

Create new query connection with timeouts

t_connect is used for connection, timeout for read/write operations

pub fn limit_lines(&mut self, limit: usize)

Set new maximum amount of lines to read per response, until DoS protection triggers.

pub fn limit_line_bytes(&mut self, limit: u64)

Set new maximum amount of bytes per line to read until DoS protection triggers.

pub fn rename(&mut self, name: &str) -> Result<(), Ts3Error>

Rename this client, performs clientupdate client_nickname escaping the name

pub fn update_description(&mut self, descr: &str) -> Result<(), Ts3Error>

Update this clients description

pub fn raw_command(&mut self, command: &str) -> Result<Vec<String>, Ts3Error>

Perform a raw command, returns its response as raw value. (No unescaping is performed.)

You need to escape the command properly.

pub fn whoami(
    &mut self,
    unescape: bool
) -> Result<HashMap<String, String>, Ts3Error>

Performs whoami

Returns a hashmap of entries. Values are unescaped if set.

pub fn logout(&mut self) -> Result<(), Ts3Error>

Logout

pub fn login(&mut self, user: &str, password: &str) -> Result<(), Ts3Error>

Login with provided data

On drop queryclient issues a logout

pub fn select_server_by_port(&mut self, port: u16) -> Result<(), Ts3Error>

Select server to perform commands on, by port

pub fn create_dir(&mut self, cid: usize, path: &str) -> Result<(), Ts3Error>

Create file directory in channel, has to be a valid path starting with /

Performs ftcreatedir

pub fn delete_file(&mut self, cid: usize, path: &str) -> Result<(), Ts3Error>

Delete File/Folder in channel, acts recursive on folders

Example: /My Directory deletes everything inside that directory.

Performs ftdeletefile

pub fn ping(&mut self) -> Result<(), Ts3Error>

Low-cost connection check

Performs whoami command without parsing

pub fn select_server_by_id(&mut self, sid: usize) -> Result<(), Ts3Error>

Select server to perform commands on, by server id

pub fn server_group_del_clients(
    &mut self,
    group: usize,
    cldbid: &[usize]
) -> Result<(), Ts3Error>

Performs servergroupdelclient

pub fn server_group_add_clients(
    &mut self,
    group: usize,
    cldbid: &[usize]
) -> Result<(), Ts3Error>

Performs servergroupaddclient

pub fn get_servergroup_client_list(
    &mut self,
    server_group: usize
) -> Result<Vec<usize>, Ts3Error>

Get a list of client-DB-IDs for a given server group ID

See servergroupclientlist

Trait Implementations

impl Drop for QueryClient

fn drop(&mut self)

Executes the destructor for this type.