Client.State.Channel

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.

Channel state

data ChannelState

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

Show ChannelState

Methods

showsPrec :: Int -> ChannelState -> ShowS

show :: ChannelState -> String

showList :: [ChannelState] -> ShowS

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]

Mask list entries

data MaskListEntry

Constructors

MaskListEntry

Fields

• _maskListSetter :: !Text
• _maskListTime :: !UTCTime

Instances

Show MaskListEntry

Methods

showsPrec :: Int -> MaskListEntry -> ShowS

show :: MaskListEntry -> String

showList :: [MaskListEntry] -> ShowS

maskListSetter :: Lens' MaskListEntry Text

maskListTime :: Lens' MaskListEntry UTCTime

Topic information

data TopicProvenance

Constructors

TopicProvenance

Fields

• _topicAuthor :: !UserInfo
• _topicTime :: !UTCTime

Instances

Show TopicProvenance

Methods

showsPrec :: Int -> TopicProvenance -> ShowS

show :: TopicProvenance -> String

showList :: [TopicProvenance] -> ShowS

topicAuthor :: Lens' TopicProvenance UserInfo

topicTime :: Lens' TopicProvenance UTCTime

Channel manipulation

newChannel :: ChannelState

Construct an empty ChannelState

setTopic :: Text -> ChannelState -> ChannelState

Set the channel topic

joinChannel :: Identifier -> ChannelState -> ChannelState

Add a user to the user list

partChannel :: Identifier -> ChannelState -> ChannelState

Remove a user from the user list

nickChange :: Identifier -> Identifier -> ChannelState -> ChannelState

Rename a user in the user list