DGNum/rust-irc
6
0
Fork 0
Code Issues 1 Pull requests 3 Projects Releases Packages Wiki Activity Actions

Enhanced documentation for user tracking API.

Browse source
This commit is contained in:
Aaron Weiss 2015-05-21 14:29:54 -04:00
parent 624873fc85
commit 7bf6bf48e1
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/client/server/mod.rs
View file

@ -26,7 +26,8 @@ pub trait Server<'a, T, U> {
/// Gets an Iterator over Commands received by this Server.
fn iter_cmd(&'a self) -> ServerCmdIterator<'a, T, U>;
/// Gets a list of Users in the specified channel. This will be none if the channel is not
/// being tracked, or if tracking is not supported altogether.
/// being tracked, or if tracking is not supported altogether. For best results, be sure to
/// request `multi-prefix` support from the server.
fn list_users(&self, channel: &str) -> Option<Vec<User>>;
}