Irc.Format

This module provides a parser and printer for the low-level IRC message format.

Documentation

data UserInfo

UserInfo packages a nickname along with the username and hsotname if they are known in the current context.

Constructors

UserInfo

Fields

• userNick :: Identifier
• userName :: Maybe ByteString
• userHost :: Maybe ByteString

Instances

Read UserInfo

Methods

readsPrec :: Int -> ReadS UserInfo

readList :: ReadS [UserInfo]

readPrec :: ReadPrec UserInfo

readListPrec :: ReadPrec [UserInfo]

Show UserInfo

Methods

showsPrec :: Int -> UserInfo -> ShowS

show :: UserInfo -> String

showList :: [UserInfo] -> ShowS

data RawIrcMsg

RawIrcMsg breaks down the IRC protocol into its most basic parts. The "trailing" parameter indicated in the IRC protocol with a leading colon will appear as the last parameter in the parameter list.

Note that RFC 2812 specifies a maximum of 15 parameters.

:prefix COMMAND param0 param1 param2 .. paramN

Constructors

RawIrcMsg

Fields

• msgTime :: Maybe UTCTime
• msgPrefix :: Maybe UserInfo
• msgCommand :: ByteString
• msgParams :: [ByteString]

Instances

Read RawIrcMsg

Methods

readsPrec :: Int -> ReadS RawIrcMsg

readList :: ReadS [RawIrcMsg]

readPrec :: ReadPrec RawIrcMsg

readListPrec :: ReadPrec [RawIrcMsg]

Show RawIrcMsg

Methods

showsPrec :: Int -> RawIrcMsg -> ShowS

show :: RawIrcMsg -> String

showList :: [RawIrcMsg] -> ShowS

parseRawIrcMsg :: ByteString -> Maybe RawIrcMsg

Attempt to split an IRC protocol message without its trailing newline information into a structured message.

renderRawIrcMsg :: RawIrcMsg -> ByteString

Serialize a structured IRC protocol message back into its wire format. This command adds the required trailing newline.

parseUserInfo :: ByteString -> UserInfo

Split up a hostmask into a nickname, username, and hostname. The username and hostname might not be defined but are delimited by a ! and @ respectively.

renderUserInfo :: UserInfo -> ByteString

Take the bytes up to the next space delimiter. If the first character of this token is a : then take the whole remaining bytestring

Render UserInfo as nick!username@hostname

data Identifier

Case insensitive identifier representing channels and nicknames

Instances

Eq Identifier

Methods

(==) :: Identifier -> Identifier -> Bool

(/=) :: Identifier -> Identifier -> Bool

Ord Identifier

Methods

compare :: Identifier -> Identifier -> Ordering

(<) :: Identifier -> Identifier -> Bool

(<=) :: Identifier -> Identifier -> Bool

(>) :: Identifier -> Identifier -> Bool

(>=) :: Identifier -> Identifier -> Bool

max :: Identifier -> Identifier -> Identifier

min :: Identifier -> Identifier -> Identifier

Read Identifier

Methods

readsPrec :: Int -> ReadS Identifier

readList :: ReadS [Identifier]

readPrec :: ReadPrec Identifier

readListPrec :: ReadPrec [Identifier]

Show Identifier

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

IsString Identifier

Methods

fromString :: String -> Identifier

mkId :: ByteString -> Identifier

Construct an Identifier from a ByteString

idBytes :: Identifier -> ByteString

Returns the original ByteString of an Identifier

idDenote :: Identifier -> ByteString

Returns the case-normalized ByteString of an Identifier which is suitable for comparison.

asUtf8 :: ByteString -> Text

ircFoldCase :: ByteString -> ByteString

Capitalize a string according to RFC 2812 Latin letters are capitalized and {|}~ are mapped to []^