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

prefix docs

Browse source
This commit is contained in:
Frankie Bagnardi 2018-09-17 22:39:48 -07:00
parent ddcd120313
commit 4728e85e0e
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
irc-proto/src/prefix.rs
View file

@ -5,14 +5,13 @@ use std::str::FromStr;
use std::fmt; use std::fmt;
/// The Prefix indicates "the true origin of the message", according to the server. /// The Prefix indicates "the true origin of the message", according to the server.
///
/// Warning: Avoid constructing a `Nickname(nickname, None, Some(hostname))`, but
/// `Nickname(nickname, Some("".to_owned()), Some(hostname))` works reliably.
#[derive(Clone, Eq, PartialEq, Debug)] #[derive(Clone, Eq, PartialEq, Debug)]
pub enum Prefix { pub enum Prefix {
/// servername /// servername, e.g. collins.mozilla.org
ServerName(String), ServerName(String),
/// nickname [ ["!" username] "@" hostname ] /// nickname [ ["!" username] "@" hostname ]
/// i.e. Nickname(nickname, username, hostname)
/// Any of the strings may be ""
Nickname(String, String, String), Nickname(String, String, String),
} }