irc-0.4.2: A small library for parsing IRC messages. Contents Index

Network.IRC.Base

Contents Type Synonyms IRC Datatypes Formatting functions Deprecated

Description

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

Synopsis

type Parameter = String type ServerName = String type UserName = String type RealName = String type Command = String data Prefix = Server ServerName | NickName String (Maybe UserName) (Maybe ServerName) data Message = Message (Maybe Prefix) Command [Parameter] encode :: Message -> String showMessage :: Message -> String showPrefix :: Prefix -> String showParameters :: [Parameter] -> String translateReply :: Command -> String replyTable :: [(String, String)] render :: Message -> String

Type Synonyms

type Parameter = String

type ServerName = String

type UserName = String

type RealName = String

type Command = String

IRC Datatypes

data Prefix

The optional beginning of an IRC messages Constructors Server ServerName Server Prefix NickName String (Maybe UserName) (Maybe ServerName) Nickname Prefix Instances Eq Prefix Read Prefix Show Prefix

data Message

IRC messages are parsed as: [ ':' prefix space ] command { space param } crlf Constructors Message (Maybe Prefix) Command [Parameter] IRC Message Instances Eq Message Read Message Show Message

Formatting functions

encode :: Message -> String

Encode a message to its string representation

showMessage :: Message -> String

showPrefix :: Prefix -> String

showParameters :: [Parameter] -> String

translateReply

:: Command Reply -> String Text translation Translate a reply into its text description. If no text is available, the argument is returned.

replyTable :: [(String, String)]

Deprecated

render :: Message -> String

This is the deprecated version of encode

Produced by Haddock version 0.8