glirc-2.41: Console IRC client

Copyright	(c) Eric Mertens 2016
License	ISC
Maintainer	[email protected]
Safe Haskell	Safe-Inferred
Language	Haskell2010

Client.Message

Contents

Client message type
Message body type
Client message operations
Quit message details
Client message operations

Description

This module provides the type used to track messages just before they are added to a window.

Synopsis

data ClientMessage = ClientMessage {
- _msgNetwork :: !Text
- _msgBody :: !MessageBody
- _msgTime :: !ZonedTime
}
msgNetwork :: Lens' ClientMessage Text
msgBody :: Lens' ClientMessage MessageBody
msgTime :: Lens' ClientMessage ZonedTime
data MessageBody
- = IrcBody !IrcMsg
- | ErrorBody !Text
- | NormalBody !Text
_IrcBody :: Prism' MessageBody IrcMsg
_ErrorBody :: Prism' MessageBody Text
_NormalBody :: Prism' MessageBody Text
data IrcSummary
- = JoinSummary !Identifier
- | QuitSummary !Identifier !QuitKind
- | PartSummary !Identifier
- | NickSummary !Identifier !Identifier
- | ReplySummary !ReplyCode
- | ChatSummary !UserInfo
- | CtcpSummary !Identifier
- | ChngSummary !Identifier
- | AcctSummary !Identifier
- | AwaySummary !Identifier !Bool
- | TagmSummary !Identifier
- | MonSummary !Identifier !Bool
- | NoSummary
msgSummary :: MessageBody -> IrcSummary
summaryActor :: IrcSummary -> Maybe Identifier
data QuitKind
- = NormalQuit
- | MassQuit
msgText :: MessageBody -> Text

Client message type

data ClientMessage Source #

Constructors

ClientMessage
Fields _msgNetwork :: !Text _msgBody :: !MessageBody _msgTime :: !ZonedTime

msgNetwork :: Lens' ClientMessage Text Source #

msgBody :: Lens' ClientMessage MessageBody Source #

msgTime :: Lens' ClientMessage ZonedTime Source #

Message body type

data MessageBody Source #

Constructors

IrcBody !IrcMsg
ErrorBody !Text
NormalBody !Text

_IrcBody :: Prism' MessageBody IrcMsg Source #

_ErrorBody :: Prism' MessageBody Text Source #

_NormalBody :: Prism' MessageBody Text Source #

Client message operations

data IrcSummary Source #

Constructors

JoinSummary !Identifier
QuitSummary !Identifier !QuitKind
PartSummary !Identifier
NickSummary !Identifier !Identifier
ReplySummary !ReplyCode
ChatSummary !UserInfo
CtcpSummary !Identifier
ChngSummary !Identifier	Chghost command
AcctSummary !Identifier	Account command
AwaySummary !Identifier !Bool
TagmSummary !Identifier	TAGMSG command
MonSummary !Identifier !Bool	MONITOR numeric replies
NoSummary

Instances

Instances details

Show IrcSummary Source #
Instance details Defined in Client.Message Methods showsPrec :: Int -> IrcSummary -> ShowS # show :: IrcSummary -> String # showList :: [IrcSummary] -> ShowS #
Eq IrcSummary Source #
Instance details Defined in Client.Message Methods (==) :: IrcSummary -> IrcSummary -> Bool # (/=) :: IrcSummary -> IrcSummary -> Bool #

msgSummary :: MessageBody -> IrcSummary Source #

summaryActor :: IrcSummary -> Maybe Identifier Source #

Quit message details

data QuitKind Source #

Constructors

NormalQuit	User quit
MassQuit	Mass event like a netsplit

Instances

Instances details

Show QuitKind Source #
Instance details Defined in Client.Message Methods showsPrec :: Int -> QuitKind -> ShowS # show :: QuitKind -> String # showList :: [QuitKind] -> ShowS #
Eq QuitKind Source #
Instance details Defined in Client.Message Methods (==) :: QuitKind -> QuitKind -> Bool # (/=) :: QuitKind -> QuitKind -> Bool #

Client message operations

msgText :: MessageBody -> Text Source #

Compute a searchable text representation of the message