var searchIndex = {};
searchIndex["sqlib"] = {"doc":"","items":[[0,"client","sqlib","The client module contains the Client and ClientList structs.",null,null],[3,"Client","sqlib::client","Client contains a TeamSpeak 3 client.\n# Example\n```\nuse sqlib::client;",null,null],[12,"clid","","client id",0,null],[12,"cid","","channel id",0,null],[12,"client_database_id","","client database id",0,null],[12,"client_nickname","","client nickname",0,null],[12,"client_type","","client type: 0 is client and 1 is query client",0,null],[12,"connection_connected_time","","connection time in milliseconds",0,null],[3,"ClientList","","ClientList contains a list of Clients.",null,null],[11,"encode","","",0,null],[11,"decode","","",0,{"inputs":[{"name":"__d"}],"output":{"name":"result"}}],[11,"clone","","",0,null],[11,"fmt","","",0,null],[11,"default","","",0,{"inputs":[],"output":{"name":"client"}}],[11,"new","","creates a new client from a client id and a nickname",0,{"inputs":[{"name":"i64"},{"name":"string"}],"output":{"name":"client"}}],[11,"is_client","","checks if it is a real client",0,null],[11,"from_map","","creates a Client from a given map.",0,{"inputs":[{"name":"stringmap"}],"output":{"name":"client"}}],[11,"update_from_map","","updates a given Client from a given map.",0,{"inputs":[{"name":"client"},{"name":"stringmap"}],"output":{"name":"client"}}],[11,"mut_from_map","","mutates self from a given map.",0,null],[11,"as_json","","creates a JSON String from self.",0,null],[11,"from_str","","",0,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"fmt","","",0,null],[11,"eq","","",0,null],[11,"partial_cmp","","",0,null],[11,"cmp","","",0,null],[11,"encode","","",1,null],[11,"decode","","",1,{"inputs":[{"name":"__d"}],"output":{"name":"result"}}],[11,"clone","","",1,null],[11,"partial_cmp","","",1,null],[11,"lt","","",1,null],[11,"le","","",1,null],[11,"gt","","",1,null],[11,"ge","","",1,null],[11,"cmp","","",1,null],[11,"eq","","",1,null],[11,"ne","","",1,null],[11,"fmt","","",1,null],[11,"new","","creates an empty ClientList",1,{"inputs":[],"output":{"name":"clientlist"}}],[11,"into_inner","","converts a ClientList into a vector of Client's",1,null],[11,"filter_clients","","filter_clients borrows a ClientList and creates a new one only with real\nclients.",1,null],[11,"from_maps","","creates a ClientList from a Vec of StringMaps",1,{"inputs":[{"name":"vec"}],"output":{"name":"clientlist"}}],[11,"as_json","","creats a JSON String from a ClientList",1,null],[11,"from_str","","",1,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"from","","",1,{"inputs":[{"name":"vec"}],"output":{"name":"clientlist"}}],[11,"deref","","",1,null],[11,"as_ref","","",1,null],[11,"as_mut","","",1,null],[11,"fmt","","",1,null],[0,"channel","sqlib","The channel module contains the Channel and ChannelList structs.",null,null],[3,"Channel","sqlib::channel","Channel contains a TeamSpeak 3 channel.\n# Example\n```\nuse sqlib::channel;",null,null],[12,"cid","","channel id",2,null],[12,"channel_name","","channel name",2,null],[12,"clients","","A vector of clients, who are in the channel.",2,null],[3,"ChannelList","","ChannelList contains a list of Channels.",null,null],[11,"encode","","",2,null],[11,"decode","","",2,{"inputs":[{"name":"__d"}],"output":{"name":"result"}}],[11,"clone","","",2,null],[11,"fmt","","",2,null],[11,"default","","",2,{"inputs":[],"output":{"name":"channel"}}],[11,"new","","Create an empty Channel from a channel id and a name.",2,{"inputs":[{"name":"i64"},{"name":"string"}],"output":{"name":"channel"}}],[11,"from_map","","Create a new Channel from a given map.",2,{"inputs":[{"name":"stringmap"}],"output":{"name":"channel"}}],[11,"update_from_map","","Create a new Channel from a given Channel and a map.",2,{"inputs":[{"name":"channel"},{"name":"stringmap"}],"output":{"name":"channel"}}],[11,"mut_from_map","","Mutate self from a given map.",2,null],[11,"is_empty","","",2,null],[11,"clients_len","","",2,null],[11,"add_client","","",2,null],[11,"sort_clients","","",2,null],[11,"remove_sq_clients","","Remove all Server Query Clients from the Channel.",2,null],[11,"as_json","","Creates a JSON String from self.",2,null],[11,"from_str","","",2,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"fmt","","",2,null],[11,"eq","","",2,null],[11,"partial_cmp","","",2,null],[11,"cmp","","",2,null],[11,"encode","","",3,null],[11,"decode","","",3,{"inputs":[{"name":"__d"}],"output":{"name":"result"}}],[11,"clone","","",3,null],[11,"partial_cmp","","",3,null],[11,"lt","","",3,null],[11,"le","","",3,null],[11,"gt","","",3,null],[11,"ge","","",3,null],[11,"cmp","","",3,null],[11,"eq","","",3,null],[11,"ne","","",3,null],[11,"fmt","","",3,null],[11,"default","","",3,{"inputs":[],"output":{"name":"channellist"}}],[11,"into_inner","","Converts a ChannelList into a vector of Channel's.",3,null],[11,"from_maps","","creates a ChannelList from a Vec of StringMaps",3,{"inputs":[{"name":"vec"}],"output":{"name":"channellist"}}],[11,"insert_client","","",3,null],[11,"merge_clients","","",3,null],[11,"as_json","","creates a JSON String from a ChannelList",3,null],[11,"deref","","",3,null],[11,"as_ref","","",3,null],[11,"as_mut","","",3,null],[11,"from_str","","",3,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"from","","",3,{"inputs":[{"name":"vec"}],"output":{"name":"self"}}],[0,"connection","sqlib","The connection module contains the Connection struct, that provides an interface for a Server\nQuery connection.",null,null],[3,"Connection","sqlib::connection","Connection provides an interface for a Server Query connection.",null,null],[11,"fmt","","",4,null],[11,"new","","creates a new Connection from an adress given as a string reference.",4,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"send_command","","sends a given command to the Server Query server and returns the answer as a String, or\nthe error.",4,null],[11,"send_command_to_map","","",4,null],[11,"send_command_vec","","",4,null],[11,"quit","","sends the quit command to the server and shuts the Connection down.",4,null],[11,"use_server_id","","sends the use command with the given id to the server.",4,null],[11,"login","","sends the login command with the name and password to the server.",4,null],[11,"change_nickname","","tries to change the nickname of the Server Query client.",4,null],[11,"clientlist","","sends the clientlist command to the server and parses the result.",4,null],[11,"clientlist_with_info","","# common errors\nIf a client disconnects between the getting of the clientlist and the getting of the client\ninformation, then there will be an error 512, because the client id is invalid.",4,null],[11,"channellist","","sends the channellist command to the server and parses the result.",4,null],[11,"channellist_with_clients","","# common errors\nIf a client disconnects between the getting of the clientlist and the getting of the client\ninformation, then there will be an error 512, because the client id is invalid.",4,null],[11,"fmt","","",4,null],[0,"command","sqlib","command contains a trait for a Command, that can be send to a Server Query server.",null,null],[8,"Command","sqlib::command","A trait for a Command, that can be send to a Server Query server.",null,null],[10,"string","","",5,null],[0,"error","sqlib","error provides newtypes and Error's for sqlib.",null,null],[3,"SQError","sqlib::error","A SQError contains a TS3 Server Query error.",null,null],[4,"Error","","Error is a custom Error type for the sqlib.",null,null],[13,"Io","","wraps io::Error",6,null],[13,"SQ","","server query error messages",6,null],[13,"Other","","other errors",6,null],[6,"Result","","The standart result type of sqlib.",null,null],[11,"fmt","","",7,null],[11,"new","","",7,{"inputs":[{"name":"u32"},{"name":"string"}],"output":{"name":"sqerror"}}],[11,"ok","","Creates an OK error.",7,{"inputs":[],"output":{"name":"sqerror"}}],[11,"parse_is_ok","","This function tries to parse a string into an Error.",7,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"parse","","try to parse a String to a SQError",7,{"inputs":[{"name":"str"}],"output":{"name":"option"}}],[11,"id","","",7,null],[11,"msg","","",7,null],[11,"eq","","",7,null],[11,"fmt","","",7,null],[11,"description","","",7,null],[11,"fmt","","",6,null],[11,"is_io","","",6,null],[11,"is_sq","","",6,null],[11,"is_other","","",6,null],[11,"description","","",6,null],[11,"fmt","","",6,null],[11,"from","","",6,{"inputs":[{"name":"str"}],"output":{"name":"error"}}],[11,"from","","",6,{"inputs":[{"name":"string"}],"output":{"name":"error"}}],[11,"from","","",6,{"inputs":[{"name":"error"}],"output":{"name":"error"}}],[11,"from","","",6,{"inputs":[{"name":"sqerror"}],"output":{"name":"error"}}],[11,"from","","",6,{"inputs":[{"name":"addrparseerror"}],"output":{"name":"error"}}],[11,"from","","",6,{"inputs":[{"name":"poisonerror"}],"output":{"name":"error"}}],[0,"map","sqlib","map provides functions around StringMap (HashMap<String, String>).",null,null],[5,"to_map","sqlib::map","creates a new StringMap from a &str.",null,{"inputs":[{"name":"str"}],"output":{"name":"stringmap"}}],[5,"update_from_map","","This function gets the value to the key from the map, then parses it and mutates the given\npointer.",null,{"inputs":[{"name":"stringmap"},{"name":"str"},{"name":"t"}],"output":null}],[6,"StringMap","","A small newtype for a HashMap of Strings.",null,null],[0,"escaping","sqlib","escaping provides functions for the Server Query escaping.",null,null],[5,"escape","sqlib::escaping","escapes all chars described in the server query manual",null,{"inputs":[{"name":"str"}],"output":{"name":"string"}}],[5,"unescape","","unescapes all chars described in the server query manual",null,{"inputs":[{"name":"str"}],"output":{"name":"string"}}],[0,"prelude","sqlib","The prelude exports all important structs and functions of sqlib.",null,null]],"paths":[[3,"Client"],[3,"ClientList"],[3,"Channel"],[3,"ChannelList"],[3,"Connection"],[8,"Command"],[4,"Error"],[3,"SQError"]]};
initSearch(searchIndex);