Network.IRC.Base

Datatypes for representing IRC messages, as well as formatting them.

Type Synonyms

type Parameter = ByteString

type ServerName = ByteString

type UserName = ByteString

type RealName = ByteString

type Command = ByteString

IRC Datatypes

data Prefix

The optional beginning of an IRC messages

Constructors

Server ServerName

Server Prefix

NickName ByteString (Maybe UserName) (Maybe ServerName)

Nickname Prefix

Instances

Read Prefix

Defined in Network.IRC.Base

Methods

readsPrec :: Int -> ReadS Prefix

readList :: ReadS [Prefix]

readPrec :: ReadPrec Prefix

readListPrec :: ReadPrec [Prefix]

Show Prefix

Defined in Network.IRC.Base

Methods

showsPrec :: Int -> Prefix -> ShowS

show :: Prefix -> String

showList :: [Prefix] -> ShowS

Eq Prefix

Defined in Network.IRC.Base

Methods

(==) :: Prefix -> Prefix -> Bool

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

data Message

IRC messages are parsed as: [ : prefix space ] command { space param } crlf

Constructors

Message

Fields

• msg_prefix :: Maybe Prefix
• msg_command :: Command
• msg_params :: [Parameter]

Instances

Read Message

Defined in Network.IRC.Base

Methods

readsPrec :: Int -> ReadS Message

readList :: ReadS [Message]

readPrec :: ReadPrec Message

readListPrec :: ReadPrec [Message]

Show Message

Defined in Network.IRC.Base

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Eq Message

Defined in Network.IRC.Base

Methods

(==) :: Message -> Message -> Bool

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

Formatting functions

encode :: Message -> ByteString

Encode a message to its string representation

showMessage :: Message -> ByteString

showPrefix :: Prefix -> ByteString

showParameters :: [Parameter] -> ByteString

translateReply

Arguments

:: Command

Reply

-> ByteString

Text translation

Translate a reply into its text description. If no text is available, the argument is returned.

replyTable :: [(ByteString, ByteString)]

Deprecated

render :: Message -> ByteString

This is the deprecated version of encode