Network.IRC.Fun.Messages

This module handles parsing and serializing IRC messages and replies. Types and other functionality are provided in the submodules.

Parsing

parseMessage :: String -> Maybe GenericMessage

Parse a raw IRC message string into a generic message structure.

messageIsReply :: GenericMessage -> Bool

Check is a given message is a server reply, i.e. has a numeric command and the sender is a server.

messageToReply :: GenericMessage -> Either String GenericReply

Try to convert a generic message into a matching reply value. If successful, return Right the reply. If the message isn't a reply, return Left an error message.

parse :: String -> Maybe (Either GenericReply GenericMessage)

Parse a raw IRC message string into a generic message structure. If the message is detected to be a server reply, a generic reply structure is returned.

This is essentially a combination of parseMessage and messageToReply.

analyzeMessage :: GenericMessage -> Either String (Either GenericReply SpecificMessage)

Read a generic message structure into specific message details. Return Left an error description if analysis fails. If the message is detected to be a reply, return a generic reply structure without analyzing.

analyzeReply :: GenericReply -> Either String SpecificReply

Read a generic reply structure into specific reply details. Return Left an error description if analysis fails.

analyze :: GenericMessage -> Either String (Either SpecificReply SpecificMessage)

Read a generic reply structure into specific message or reply details. Return Left an error description if analysis fails.

This is essentially a combination or analyzeMessage and 'analyzeReply.

Serializing

buildMessage :: SpecificMessage -> GenericMessage

Fill a generic message record using a specific message's details.

buildReply :: SpecificReply -> GenericReply

Fill a generic reply record using a specific reply's details.

messageFromReply :: GenericReply -> GenericMessage

Convert a reply, which is a message with a numeric command name, into a generic message value.

serializeMessage :: GenericMessage -> String

Write a message into an IRC protocol message formatted string.

serializeReply :: GenericReply -> String

Write a reply into an IRC protocol message formatted string.

This is essentially a combination of messageFromReply and serializeMessage.