Copyright	(c) 2016 Michael Walker
License	MIT
Maintainer	Michael Walker <mike@barrucadu.co.uk>
Stability	experimental
Portability	BangPatterns, DeriveFunctor, OverloadedStrings, RankNTypes, TupleSections
Safe Haskell	Safe
Language	Haskell2010

Network.IRC.Conduit.Internal

Contents

Internal Lens synonyms
Conduits
Type synonyms
Messages
Decoding messages
Encoding messages

Description

Internal IRC conduit types and utilities. This module is NOT considered to form part of the public interface of this library.

Synopsis

Internal Lens synonyms

type Lens s t a b = forall f. Functor f => (a -> f b) -> s -> f t #

See Control.Lens.Lens.Lens.

type Lens' s a = Lens s s a a #

A Simple Lens.

type Prism s t a b = forall p f. (Choice p, Applicative f) => p a (f b) -> p s (f t) #

See Control.Lens.Prism.Prism.

type Prism' s a = Prism s s a a #

A Simple Prism.

Conduits

chunked :: Monad m => Conduit ByteString m ByteString #

Split up incoming bytestrings into new lines.

Type synonyms

type ChannelName a = a #

type NickName a = a #

type ServerName a = a #

type Reason a = Maybe a #

type IsModeSet = Bool #

type ModeFlag a = a #

type ModeArg a = a #

type NumericArg a = a #

type Target a = a #

The target of a message. Will be a nick or channel name.

type IrcEvent = Event ByteString #

type IrcSource = Source ByteString #

type IrcMessage = Message ByteString #

Messages

data Event a #

A decoded IRC message + source.

Constructors

Event
Fields _raw :: ByteString The message as a bytestring. _source :: Source a The source of the message (user, channel, or server). _message :: Message a The decoded message. This will never be a `RawMsg`.

Instances

Functor Event #
Methods fmap :: (a -> b) -> Event a -> Event b # (<$) :: a -> Event b -> Event a #
Eq (NickName a) => Eq (Event a) #
Methods (==) :: Event a -> Event a -> Bool # (/=) :: Event a -> Event a -> Bool #
Show (NickName a) => Show (Event a) #
Methods showsPrec :: Int -> Event a -> ShowS # show :: Event a -> String # showList :: [Event a] -> ShowS #

data Source a #

The source of an IRC message.

Constructors

User (NickName a)	The message comes directly from a user.
Channel (ChannelName a) (NickName a)	The message comes from a user in a channel.
Server (ServerName a)	The message comes directly from the server.

Instances

Functor Source #
Methods fmap :: (a -> b) -> Source a -> Source b # (<$) :: a -> Source b -> Source a #
Eq (NickName a) => Eq (Source a) #
Methods (==) :: Source a -> Source a -> Bool # (/=) :: Source a -> Source a -> Bool #
Show (NickName a) => Show (Source a) #
Methods showsPrec :: Int -> Source a -> ShowS # show :: Source a -> String # showList :: [Source a] -> ShowS #

data Message a #

A decoded IRC message.

Constructors

Privmsg (Target a) (Either CTCPByteString a)	A message, either from a user or to a channel the client is in. CTCPs are distinguished by starting and ending with a \001 (SOH).
Notice (Target a) (Either CTCPByteString a)	Like a privmsg, but should not provoke an automatic response.
Nick (NickName a)	Someone has updated their nick.
Join (ChannelName a)	Someone has joined a channel.
Part (ChannelName a) (Reason a)	Someone has left a channel.
Quit (Reason a)	Someone has left the network.
Mode (Target a) IsModeSet [ModeFlag a] [ModeArg a]	Someone has set some channel modes or user modes.
Topic (ChannelName a) a	Someone has set the topic of a channel.
Invite (ChannelName a) (NickName a)	The client has been invited to a channel.
Kick (ChannelName a) (NickName a) (Reason a)	Someone has been kicked from a channel.
Ping (ServerName a) (Maybe (ServerName a))	The client has received a server ping, and should send a pong asap.
Pong (ServerName a)	A pong sent to the named server.
Numeric Int [NumericArg a]	One of the many server numeric responses.
RawMsg a	Never produced by decoding, but can be used to send arbitrary bytestrings to the IRC server. Naturally, this should only be used when you are confident that the produced bytestring will be a valid IRC message.

Instances

Functor Message #
Methods fmap :: (a -> b) -> Message a -> Message b # (<$) :: a -> Message b -> Message a #
Eq (Target a) => Eq (Message a) #
Methods (==) :: Message a -> Message a -> Bool # (/=) :: Message a -> Message a -> Bool #
Show (Target a) => Show (Message a) #
Methods showsPrec :: Int -> Message a -> ShowS # show :: Message a -> String # showList :: [Message a] -> ShowS #

Decoding messages

fromByteString :: ByteString -> Either ByteString IrcEvent #

attemptDecode :: ByteString -> Maybe (IrcSource, IrcMessage) #

Attempt to decode a ByteString into a message, returning a Nothing if either the source or the message can't be determined.

Encoding messages

toByteString :: IrcMessage -> ByteString #

Encode an IRC message into a single bytestring suitable for sending to the server.

mkMessage :: ByteString -> [ByteString] -> ByteString #

rawMessage #

Arguments

:: ByteString	The command
-> [ByteString]	The arguments
-> IrcMessage

Construct a raw message.