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

Network.IRC.Types

Contents Type Synonyms Properties IRC Datatypes Formatting functions

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 class Prop a where renderProp :: a -> String data Mode p where Add :: Prop p => [p] -> Mode p Remove :: Prop p => [p] -> Mode p data UserProp = UserOp | Invisible | ServerNotices | Wallops data ChanProp = ChanOp | Private | Secret | InviteOnly | TopicOpOnly | NoOutsideMessages | Moderated | UserLimit | BanMask | Speak | Password data Prefix = Server ServerName | NickName String Maybe UserName Maybe ServerName data Message = Message Maybe Prefix Command [Parameter] render :: Message -> String renderMode :: Prop p => Mode p -> String translateReply :: Command -> String

Type Synonyms

type Parameter = String

type ServerName = String

type UserName = String

type RealName = String

type Command = String

Properties

class Prop a where

Property class Methods renderProp :: a -> String Instances Prop ChanProp Prop UserProp

data Mode p where

IRC Modes Constructors Add :: Prop p => [p] -> Mode p Remove :: Prop p => [p] -> Mode p Instances Show p => Show (Mode p)

data UserProp

User properties Constructors UserOp Invisible ServerNotices Wallops Instances Eq UserProp Show UserProp Prop UserProp

data ChanProp

Channel properties Constructors ChanOp Private Secret InviteOnly TopicOpOnly NoOutsideMessages Moderated UserLimit BanMask Speak Password Instances Eq ChanProp Show ChanProp Prop ChanProp

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

render

:: Message IRC Message -> String Rendered message Message rendering

renderMode :: Prop p => Mode p -> String

translateReply

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

Produced by Haddock version 2.1.0