Copyright	(c) Eric Mertens 2016
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Client.State.Channel

Contents

Channel state
Mask list entries
Topic information
Channel manipulation

Description

This module is responsible for tracking the state of an individual IRC channel while the client is connected to it. When the client joins a channel a new channel session is created and when the client leaves a channel is it destroyed.

Synopsis

data ChannelState = ChannelState {
- _chanTopic :: !Text
- _chanTopicProvenance :: !(Maybe TopicProvenance)
- _chanUrl :: !(Maybe Text)
- _chanUsers :: !(HashMap Identifier String)
- _chanModes :: !(Map Char Text)
- _chanLists :: !(Map Char (HashMap Text MaskListEntry))
- _chanCreation :: !(Maybe UTCTime)
- _chanQueuedModeration :: ![RawIrcMsg]
}
chanTopic :: Lens' ChannelState Text
chanTopicProvenance :: Lens' ChannelState (Maybe TopicProvenance)
chanUrl :: Lens' ChannelState (Maybe Text)
chanUsers :: Lens' ChannelState (HashMap Identifier String)
chanModes :: Lens' ChannelState (Map Char Text)
chanLists :: Lens' ChannelState (Map Char (HashMap Text MaskListEntry))
chanCreation :: Lens' ChannelState (Maybe UTCTime)
chanQueuedModeration :: Lens' ChannelState [RawIrcMsg]
data MaskListEntry = MaskListEntry {
- _maskListSetter :: !Text
- _maskListTime :: !UTCTime
}
maskListSetter :: Lens' MaskListEntry Text
maskListTime :: Lens' MaskListEntry UTCTime
data TopicProvenance = TopicProvenance {
- _topicAuthor :: !UserInfo
- _topicTime :: !UTCTime
}
topicAuthor :: Lens' TopicProvenance UserInfo
topicTime :: Lens' TopicProvenance UTCTime
newChannel :: ChannelState
setTopic :: Text -> ChannelState -> ChannelState
joinChannel :: Identifier -> ChannelState -> ChannelState
partChannel :: Identifier -> ChannelState -> ChannelState
nickChange :: Identifier -> Identifier -> ChannelState -> ChannelState

Channel state

data ChannelState Source #

Dynamic information about the state of an IRC channel

Constructors

ChannelState

Fields

_chanTopic :: !Text
topic text
_chanTopicProvenance :: !(Maybe TopicProvenance)
author and timestamp for topic
_chanUrl :: !(Maybe Text)
channel URL
_chanUsers :: !(HashMap Identifier String)
user list and sigils
_chanModes :: !(Map Char Text)
channel settings and parameters
_chanLists :: !(Map Char (HashMap Text MaskListEntry))
mode, mask, setter, set time
_chanCreation :: !(Maybe UTCTime)
creation time of channel
_chanQueuedModeration :: ![RawIrcMsg]
delayed op messages

Instances

Instances details

Show ChannelState Source #
Instance details Defined in Client.State.Channel Methods showsPrec :: Int -> ChannelState -> ShowS # show :: ChannelState -> String # showList :: [ChannelState] -> ShowS #

chanTopic :: Lens' ChannelState Text Source #

chanTopicProvenance :: Lens' ChannelState (Maybe TopicProvenance) Source #

chanUrl :: Lens' ChannelState (Maybe Text) Source #

chanUsers :: Lens' ChannelState (HashMap Identifier String) Source #

chanModes :: Lens' ChannelState (Map Char Text) Source #

chanLists :: Lens' ChannelState (Map Char (HashMap Text MaskListEntry)) Source #

chanCreation :: Lens' ChannelState (Maybe UTCTime) Source #

chanQueuedModeration :: Lens' ChannelState [RawIrcMsg] Source #

Mask list entries

data MaskListEntry Source #

Constructors

MaskListEntry
Fields _maskListSetter :: !Text _maskListTime :: !UTCTime

Instances

Instances details

Show MaskListEntry Source #
Instance details Defined in Client.State.Channel Methods showsPrec :: Int -> MaskListEntry -> ShowS # show :: MaskListEntry -> String # showList :: [MaskListEntry] -> ShowS #

maskListSetter :: Lens' MaskListEntry Text Source #

maskListTime :: Lens' MaskListEntry UTCTime Source #

Topic information

data TopicProvenance Source #

Constructors

TopicProvenance
Fields _topicAuthor :: !UserInfo _topicTime :: !UTCTime

Instances

Instances details

Show TopicProvenance Source #
Instance details Defined in Client.State.Channel Methods showsPrec :: Int -> TopicProvenance -> ShowS # show :: TopicProvenance -> String # showList :: [TopicProvenance] -> ShowS #

topicAuthor :: Lens' TopicProvenance UserInfo Source #

topicTime :: Lens' TopicProvenance UTCTime Source #

Channel manipulation

newChannel :: ChannelState Source #

Construct an empty ChannelState

setTopic :: Text -> ChannelState -> ChannelState Source #

Set the channel topic

joinChannel :: Identifier -> ChannelState -> ChannelState Source #

Add a user to the user list

partChannel :: Identifier -> ChannelState -> ChannelState Source #

Remove a user from the user list

nickChange :: Identifier -> Identifier -> ChannelState -> ChannelState Source #

Rename a user in the user list