Network.Yak

Documentation

emit :: forall c p. (Parameter (PList p), KnownSymbol c) => Msg c p -> ByteString

Encode an IRC message to a ByteString, ready for the network

emitSome :: SomeMsg -> ByteString

Encode existentially quantified message.

class Fetch a

Minimal complete definition

fetch

Instances

(Fetch a, Fetch b) => Fetch (Either a b)

Defined in Network.Yak

Methods

fetch :: ByteString -> Maybe (Either a b)

(Parameter (PList p), KnownSymbol c) => Fetch (Msg c p)

Defined in Network.Yak

Methods

fetch :: ByteString -> Maybe (Msg c p)

fetch :: Fetch a => ByteString -> Maybe a

Decode an IRC message from a ByteString into a Msg or a coproduct thereof. This function is return type polymorphic and will pick a parser that fits the requested type, which is determined either by type inference or can be picked by explicit type annotation.

fetch' :: forall c p. (Parameter (PList p), KnownSymbol c) => Parser (Msg c p)

Like fetch but offers the underlying attoparsec Parser. This can be used for e.g. the construction of ad-hoc sum types catching multiple message types.

Messages

build :: Build '[] f => f

Generalized constructor function for the creation of Msg values. The types here may seem opaque, but essentially this is a variadic type-safe constructor.

build "hunter2" :: Pass
build [Channel "#haskell"] (Message "hello world!") :: PrivMsg

The type annotations may or may not be necessary, depending on the information available to the compiler at the use site.

buildPrefix :: Build '[] f => Prefix -> f

Like build but takes a Prefix that will be added to the message.

vacant :: Msg c '[]

castMsg :: (KnownSymbol c1, KnownSymbol c2) => Msg c1 p -> Msg c2 p

Safely cast one message to another. Equality of parameter lists is statically enforced.

(<:>) :: x -> Msg c xs -> Msg c (x ': xs) infixr 5

Types

data Host

Constructors

Host Nickname (Maybe Username) (Maybe Hostname)

Instances

Eq Host

Defined in Network.Yak.Types

Methods

(==) :: Host -> Host -> Bool

(/=) :: Host -> Host -> Bool

Ord Host

Defined in Network.Yak.Types

Methods

compare :: Host -> Host -> Ordering

(<) :: Host -> Host -> Bool

(<=) :: Host -> Host -> Bool

(>) :: Host -> Host -> Bool

(>=) :: Host -> Host -> Bool

max :: Host -> Host -> Host

min :: Host -> Host -> Host

Read Host

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS Host

readList :: ReadS [Host]

readPrec :: ReadPrec Host

readListPrec :: ReadPrec [Host]

Show Host

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Host -> ShowS

show :: Host -> String

showList :: [Host] -> ShowS

Generic Host

Defined in Network.Yak.Types

Associated Types

type Rep Host :: Type -> Type

Methods

from :: Host -> Rep Host x

to :: Rep Host x -> Host

Parameter Host

Defined in Network.Yak.Types

Methods

render :: Host -> ByteString

seize :: Parser Host

type Rep Host

Defined in Network.Yak.Types

type Rep Host = D1 (MetaData "Host" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "Host" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Nickname) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Username)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Hostname)))))

hostNick :: Lens' Host Nickname

hostUser :: Lens' Host (Maybe Username)

hostHost :: Lens' Host (Maybe Hostname)

data UReply

Replies to Userhost queries.

Constructors

UReply Nickname Bool Bool Hostname

Instances

Eq UReply

Defined in Network.Yak.Types

Methods

(==) :: UReply -> UReply -> Bool

(/=) :: UReply -> UReply -> Bool

Ord UReply

Defined in Network.Yak.Types

Methods

compare :: UReply -> UReply -> Ordering

(<) :: UReply -> UReply -> Bool

(<=) :: UReply -> UReply -> Bool

(>) :: UReply -> UReply -> Bool

(>=) :: UReply -> UReply -> Bool

max :: UReply -> UReply -> UReply

min :: UReply -> UReply -> UReply

Read UReply

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS UReply

readList :: ReadS [UReply]

readPrec :: ReadPrec UReply

readListPrec :: ReadPrec [UReply]

Show UReply

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> UReply -> ShowS

show :: UReply -> String

showList :: [UReply] -> ShowS

Generic UReply

Defined in Network.Yak.Types

Associated Types

type Rep UReply :: Type -> Type

Methods

from :: UReply -> Rep UReply x

to :: Rep UReply x -> UReply

Parameter UReply

Defined in Network.Yak.Types

Methods

render :: UReply -> ByteString

seize :: Parser UReply

type Rep UReply

Defined in Network.Yak.Types

type Rep UReply = D1 (MetaData "UReply" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "UReply" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Nickname) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Hostname))))

ureplyNick :: Lens' UReply Nickname

ureplyIsOp :: Lens' UReply Bool

ureplyIsAway :: Lens' UReply Bool

ureplyHostname :: Lens' UReply Hostname

data Member a

Constructors

Member (Maybe Char) a

Instances

Eq a => Eq (Member a)

Defined in Network.Yak.Types

Methods

(==) :: Member a -> Member a -> Bool

(/=) :: Member a -> Member a -> Bool

Ord a => Ord (Member a)

Defined in Network.Yak.Types

Methods

compare :: Member a -> Member a -> Ordering

(<) :: Member a -> Member a -> Bool

(<=) :: Member a -> Member a -> Bool

(>) :: Member a -> Member a -> Bool

(>=) :: Member a -> Member a -> Bool

max :: Member a -> Member a -> Member a

min :: Member a -> Member a -> Member a

Read a => Read (Member a)

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS (Member a)

readList :: ReadS [Member a]

readPrec :: ReadPrec (Member a)

readListPrec :: ReadPrec [Member a]

Show a => Show (Member a)

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Member a -> ShowS

show :: Member a -> String

showList :: [Member a] -> ShowS

Generic (Member a)

Defined in Network.Yak.Types

Associated Types

type Rep (Member a) :: Type -> Type

Methods

from :: Member a -> Rep (Member a) x

to :: Rep (Member a) x -> Member a

Parameter a => Parameter (Member a)

Defined in Network.Yak.Types

Methods

render :: Member a -> ByteString

seize :: Parser (Member a)

type Rep (Member a)

Defined in Network.Yak.Types

type Rep (Member a) = D1 (MetaData "Member" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "Member" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Char)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

memberPrefix :: forall a. Lens' (Member a) (Maybe Char)

memberData :: forall a a. Lens (Member a) (Member a) a a

type Hostname = Text

type Mask = Text

type Nickname = Text

type Username = Text

data PList a where

Heterogeneous list of parameters.

Constructors

PNil :: PList '[]

PCons :: forall x xs. x -> PList xs -> PList (x ': xs)

Instances

(Eq x, Eq (PList xs)) => Eq (PList (x ': xs))

Defined in Network.Yak.Types

Methods

(==) :: PList (x ': xs) -> PList (x ': xs) -> Bool

(/=) :: PList (x ': xs) -> PList (x ': xs) -> Bool

Eq (PList ([] :: [Type]))

Defined in Network.Yak.Types

Methods

(==) :: PList [] -> PList [] -> Bool

(/=) :: PList [] -> PList [] -> Bool

(Show x, Show (PList xs)) => Show (PList (x ': xs))

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> PList (x ': xs) -> ShowS

show :: PList (x ': xs) -> String

showList :: [PList (x ': xs)] -> ShowS

Show (PList ([] :: [Type]))

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> PList [] -> ShowS

show :: PList [] -> String

showList :: [PList []] -> ShowS

(Parameter x, Parameter (PList xs)) => Parameter (PList (x ': xs))

Defined in Network.Yak.Types

Methods

render :: PList (x ': xs) -> ByteString

seize :: Parser (PList (x ': xs))

Parameter (PList ([] :: [Type]))

Defined in Network.Yak.Types

Methods

render :: PList [] -> ByteString

seize :: Parser (PList [])

(Parameter x, Parameter x') => Field1 (PList (x ': xs)) (PList (x' ': xs)) x x'

Defined in Network.Yak.Types

Methods

_1 :: Lens (PList (x ': xs)) (PList (x' ': xs)) x x'

(Parameter x, Parameter x') => Field2 (PList (a ': (x ': xs))) (PList (a ': (x' ': xs))) x x'

Defined in Network.Yak.Types

Methods

_2 :: Lens (PList (a ': (x ': xs))) (PList (a ': (x' ': xs))) x x'

(Parameter x, Parameter x') => Field3 (PList (a ': (b ': (x ': xs)))) (PList (a ': (b ': (x' ': xs)))) x x'

Defined in Network.Yak.Types

Methods

_3 :: Lens (PList (a ': (b ': (x ': xs)))) (PList (a ': (b ': (x' ': xs)))) x x'

(Parameter x, Parameter x') => Field4 (PList (a ': (b ': (c ': (x ': xs))))) (PList (a ': (b ': (c ': (x' ': xs))))) x x'

Defined in Network.Yak.Types

Methods

_4 :: Lens (PList (a ': (b ': (c ': (x ': xs))))) (PList (a ': (b ': (c ': (x' ': xs))))) x x'

(Parameter x, Parameter x') => Field5 (PList (a ': (b ': (c ': (d ': (x ': xs)))))) (PList (a ': (b ': (c ': (d ': (x' ': xs)))))) x x'

Defined in Network.Yak.Types

Methods

_5 :: Lens (PList (a ': (b ': (c ': (d ': (x ': xs)))))) (PList (a ': (b ': (c ': (d ': (x' ': xs)))))) x x'

(Parameter x, Parameter x') => Field6 (PList (a ': (b ': (c ': (d ': (e ': (x ': xs))))))) (PList (a ': (b ': (c ': (d ': (e ': (x' ': xs))))))) x x'

Defined in Network.Yak.Types

Methods

_6 :: Lens (PList (a ': (b ': (c ': (d ': (e ': (x ': xs))))))) (PList (a ': (b ': (c ': (d ': (e ': (x' ': xs))))))) x x'

(Parameter x, Parameter x') => Field7 (PList (a ': (b ': (c ': (d ': (e ': (f ': (x ': xs)))))))) (PList (a ': (b ': (c ': (d ': (e ': (f ': (x' ': xs)))))))) x x'

Defined in Network.Yak.Types

Methods

_7 :: Lens (PList (a ': (b ': (c ': (d ': (e ': (f ': (x ': xs)))))))) (PList (a ': (b ': (c ': (d ': (e ': (f ': (x' ': xs)))))))) x x'

(Parameter x, Parameter x') => Field8 (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (x ': xs))))))))) (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (x' ': xs))))))))) x x'

Defined in Network.Yak.Types

Methods

_8 :: Lens (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (x ': xs))))))))) (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (x' ': xs))))))))) x x'

(Parameter x, Parameter x') => Field9 (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (h ': (x ': xs)))))))))) (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (h ': (x' ': xs)))))))))) x x'

Defined in Network.Yak.Types

Methods

_9 :: Lens (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (h ': (x ': xs)))))))))) (PList (a ': (b ': (c ': (d ': (e ': (f ': (g ': (h ': (x' ': xs)))))))))) x x'

newtype CList a

Space separated lists after colon. Used in some numeric replies

Constructors

CList

Fields

• getCList :: [a]

Instances

Monad CList

Defined in Network.Yak.Types

Methods

(>>=) :: CList a -> (a -> CList b) -> CList b

(>>) :: CList a -> CList b -> CList b

return :: a -> CList a

fail :: String -> CList a

Functor CList

Defined in Network.Yak.Types

Methods

fmap :: (a -> b) -> CList a -> CList b

(<$) :: a -> CList b -> CList a

Applicative CList

Defined in Network.Yak.Types

Methods

pure :: a -> CList a

(<*>) :: CList (a -> b) -> CList a -> CList b

liftA2 :: (a -> b -> c) -> CList a -> CList b -> CList c

(*>) :: CList a -> CList b -> CList b

(<*) :: CList a -> CList b -> CList a

Foldable CList

Defined in Network.Yak.Types

Methods

fold :: Monoid m => CList m -> m

foldMap :: Monoid m => (a -> m) -> CList a -> m

foldr :: (a -> b -> b) -> b -> CList a -> b

foldr' :: (a -> b -> b) -> b -> CList a -> b

foldl :: (b -> a -> b) -> b -> CList a -> b

foldl' :: (b -> a -> b) -> b -> CList a -> b

foldr1 :: (a -> a -> a) -> CList a -> a

foldl1 :: (a -> a -> a) -> CList a -> a

toList :: CList a -> [a]

null :: CList a -> Bool

length :: CList a -> Int

elem :: Eq a => a -> CList a -> Bool

maximum :: Ord a => CList a -> a

minimum :: Ord a => CList a -> a

sum :: Num a => CList a -> a

product :: Num a => CList a -> a

Traversable CList

Defined in Network.Yak.Types

Methods

traverse :: Applicative f => (a -> f b) -> CList a -> f (CList b)

sequenceA :: Applicative f => CList (f a) -> f (CList a)

mapM :: Monad m => (a -> m b) -> CList a -> m (CList b)

sequence :: Monad m => CList (m a) -> m (CList a)

Alternative CList

Defined in Network.Yak.Types

Methods

empty :: CList a

(<|>) :: CList a -> CList a -> CList a

some :: CList a -> CList [a]

many :: CList a -> CList [a]

IsList (CList a)

Syntactic sugar for construction

Defined in Network.Yak.Types

Associated Types

type Item (CList a) :: Type

Methods

fromList :: [Item (CList a)] -> CList a

fromListN :: Int -> [Item (CList a)] -> CList a

toList :: CList a -> [Item (CList a)]

Eq a => Eq (CList a)

Defined in Network.Yak.Types

Methods

(==) :: CList a -> CList a -> Bool

(/=) :: CList a -> CList a -> Bool

Ord a => Ord (CList a)

Defined in Network.Yak.Types

Methods

compare :: CList a -> CList a -> Ordering

(<) :: CList a -> CList a -> Bool

(<=) :: CList a -> CList a -> Bool

(>) :: CList a -> CList a -> Bool

(>=) :: CList a -> CList a -> Bool

max :: CList a -> CList a -> CList a

min :: CList a -> CList a -> CList a

Read a => Read (CList a)

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS (CList a)

readList :: ReadS [CList a]

readPrec :: ReadPrec (CList a)

readListPrec :: ReadPrec [CList a]

Show a => Show (CList a)

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> CList a -> ShowS

show :: CList a -> String

showList :: [CList a] -> ShowS

Generic (CList a)

Defined in Network.Yak.Types

Associated Types

type Rep (CList a) :: Type -> Type

Methods

from :: CList a -> Rep (CList a) x

to :: Rep (CList a) x -> CList a

Semigroup (CList a)

Defined in Network.Yak.Types

Methods

(<>) :: CList a -> CList a -> CList a

sconcat :: NonEmpty (CList a) -> CList a

stimes :: Integral b => b -> CList a -> CList a

Monoid (CList a)

Defined in Network.Yak.Types

Methods

mempty :: CList a

mappend :: CList a -> CList a -> CList a

mconcat :: [CList a] -> CList a

Wrapped (CList a)

Defined in Network.Yak.Types

Associated Types

type Unwrapped (CList a) :: Type

Methods

_Wrapped' :: Iso' (CList a) (Unwrapped (CList a))

Parameter a => Parameter (CList a)

Defined in Network.Yak.Types

Methods

render :: CList a -> ByteString

seize :: Parser (CList a)

t ~ CList b => Rewrapped (CList a) t

Defined in Network.Yak.Types

type Rep (CList a)

Defined in Network.Yak.Types

type Rep (CList a) = D1 (MetaData "CList" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" True) (C1 (MetaCons "CList" PrefixI True) (S1 (MetaSel (Just "getCList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a])))

type Item (CList a)

Defined in Network.Yak.Types

type Item (CList a) = a

type Unwrapped (CList a)

Defined in Network.Yak.Types

type Unwrapped (CList a) = [a]

newtype SList a

Space separated lists. Use with caution, since spaces are also the separator for PList!

Constructors

SList

Fields

• getSList :: [a]

Instances

Monad SList

Defined in Network.Yak.Types

Methods

(>>=) :: SList a -> (a -> SList b) -> SList b

(>>) :: SList a -> SList b -> SList b

return :: a -> SList a

fail :: String -> SList a

Functor SList

Defined in Network.Yak.Types

Methods

fmap :: (a -> b) -> SList a -> SList b

(<$) :: a -> SList b -> SList a

Applicative SList

Defined in Network.Yak.Types

Methods

pure :: a -> SList a

(<*>) :: SList (a -> b) -> SList a -> SList b

liftA2 :: (a -> b -> c) -> SList a -> SList b -> SList c

(*>) :: SList a -> SList b -> SList b

(<*) :: SList a -> SList b -> SList a

Foldable SList

Defined in Network.Yak.Types

Methods

fold :: Monoid m => SList m -> m

foldMap :: Monoid m => (a -> m) -> SList a -> m

foldr :: (a -> b -> b) -> b -> SList a -> b

foldr' :: (a -> b -> b) -> b -> SList a -> b

foldl :: (b -> a -> b) -> b -> SList a -> b

foldl' :: (b -> a -> b) -> b -> SList a -> b

foldr1 :: (a -> a -> a) -> SList a -> a

foldl1 :: (a -> a -> a) -> SList a -> a

toList :: SList a -> [a]

null :: SList a -> Bool

length :: SList a -> Int

elem :: Eq a => a -> SList a -> Bool

maximum :: Ord a => SList a -> a

minimum :: Ord a => SList a -> a

sum :: Num a => SList a -> a

product :: Num a => SList a -> a

Traversable SList

Defined in Network.Yak.Types

Methods

traverse :: Applicative f => (a -> f b) -> SList a -> f (SList b)

sequenceA :: Applicative f => SList (f a) -> f (SList a)

mapM :: Monad m => (a -> m b) -> SList a -> m (SList b)

sequence :: Monad m => SList (m a) -> m (SList a)

Alternative SList

Defined in Network.Yak.Types

Methods

empty :: SList a

(<|>) :: SList a -> SList a -> SList a

some :: SList a -> SList [a]

many :: SList a -> SList [a]

IsList (SList a)

Syntactic sugar for construction

Defined in Network.Yak.Types

Associated Types

type Item (SList a) :: Type

Methods

fromList :: [Item (SList a)] -> SList a

fromListN :: Int -> [Item (SList a)] -> SList a

toList :: SList a -> [Item (SList a)]

Eq a => Eq (SList a)

Defined in Network.Yak.Types

Methods

(==) :: SList a -> SList a -> Bool

(/=) :: SList a -> SList a -> Bool

Ord a => Ord (SList a)

Defined in Network.Yak.Types

Methods

compare :: SList a -> SList a -> Ordering

(<) :: SList a -> SList a -> Bool

(<=) :: SList a -> SList a -> Bool

(>) :: SList a -> SList a -> Bool

(>=) :: SList a -> SList a -> Bool

max :: SList a -> SList a -> SList a

min :: SList a -> SList a -> SList a

Read a => Read (SList a)

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS (SList a)

readList :: ReadS [SList a]

readPrec :: ReadPrec (SList a)

readListPrec :: ReadPrec [SList a]

Show a => Show (SList a)

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> SList a -> ShowS

show :: SList a -> String

showList :: [SList a] -> ShowS

Generic (SList a)

Defined in Network.Yak.Types

Associated Types

type Rep (SList a) :: Type -> Type

Methods

from :: SList a -> Rep (SList a) x

to :: Rep (SList a) x -> SList a

Semigroup (SList a)

Defined in Network.Yak.Types

Methods

(<>) :: SList a -> SList a -> SList a

sconcat :: NonEmpty (SList a) -> SList a

stimes :: Integral b => b -> SList a -> SList a

Monoid (SList a)

Defined in Network.Yak.Types

Methods

mempty :: SList a

mappend :: SList a -> SList a -> SList a

mconcat :: [SList a] -> SList a

Wrapped (SList a)

Defined in Network.Yak.Types

Associated Types

type Unwrapped (SList a) :: Type

Methods

_Wrapped' :: Iso' (SList a) (Unwrapped (SList a))

Parameter a => Parameter (SList a)

Defined in Network.Yak.Types

Methods

render :: SList a -> ByteString

seize :: Parser (SList a)

t ~ SList b => Rewrapped (SList a) t

Defined in Network.Yak.Types

type Rep (SList a)

Defined in Network.Yak.Types

type Rep (SList a) = D1 (MetaData "SList" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" True) (C1 (MetaCons "SList" PrefixI True) (S1 (MetaSel (Just "getSList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a])))

type Item (SList a)

Defined in Network.Yak.Types

type Item (SList a) = a

type Unwrapped (SList a)

Defined in Network.Yak.Types

type Unwrapped (SList a) = [a]

data Flag a

Type for expressing possibly missing flags.

Constructors

Set

Unset

Instances

Eq (Flag a)

Defined in Network.Yak.Types

Methods

(==) :: Flag a -> Flag a -> Bool

(/=) :: Flag a -> Flag a -> Bool

Ord (Flag a)

Defined in Network.Yak.Types

Methods

compare :: Flag a -> Flag a -> Ordering

(<) :: Flag a -> Flag a -> Bool

(<=) :: Flag a -> Flag a -> Bool

(>) :: Flag a -> Flag a -> Bool

(>=) :: Flag a -> Flag a -> Bool

max :: Flag a -> Flag a -> Flag a

min :: Flag a -> Flag a -> Flag a

Read (Flag a)

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS (Flag a)

readList :: ReadS [Flag a]

readPrec :: ReadPrec (Flag a)

readListPrec :: ReadPrec [Flag a]

Show (Flag a)

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Flag a -> ShowS

show :: Flag a -> String

showList :: [Flag a] -> ShowS

Generic (Flag a)

Defined in Network.Yak.Types

Associated Types

type Rep (Flag a) :: Type -> Type

Methods

from :: Flag a -> Rep (Flag a) x

to :: Rep (Flag a) x -> Flag a

KnownSymbol a => Parameter (Flag a)

Defined in Network.Yak.Types

Methods

render :: Flag a -> ByteString

seize :: Parser (Flag a)

type Rep (Flag a)

Defined in Network.Yak.Types

type Rep (Flag a) = D1 (MetaData "Flag" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "Set" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Unset" PrefixI False) (U1 :: Type -> Type))

data Unused (a :: Symbol)

Proxy type for inserting special syntax

Constructors

Unused

Instances

Eq (Unused a)

Defined in Network.Yak.Types

Methods

(==) :: Unused a -> Unused a -> Bool

(/=) :: Unused a -> Unused a -> Bool

Ord (Unused a)

Defined in Network.Yak.Types

Methods

compare :: Unused a -> Unused a -> Ordering

(<) :: Unused a -> Unused a -> Bool

(<=) :: Unused a -> Unused a -> Bool

(>) :: Unused a -> Unused a -> Bool

(>=) :: Unused a -> Unused a -> Bool

max :: Unused a -> Unused a -> Unused a

min :: Unused a -> Unused a -> Unused a

Read (Unused a)

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS (Unused a)

readList :: ReadS [Unused a]

readPrec :: ReadPrec (Unused a)

readListPrec :: ReadPrec [Unused a]

Show (Unused a)

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Unused a -> ShowS

show :: Unused a -> String

showList :: [Unused a] -> ShowS

Generic (Unused a)

Defined in Network.Yak.Types

Associated Types

type Rep (Unused a) :: Type -> Type

Methods

from :: Unused a -> Rep (Unused a) x

to :: Rep (Unused a) x -> Unused a

KnownSymbol a => Parameter (Unused a)

Defined in Network.Yak.Types

Methods

render :: Unused a -> ByteString

seize :: Parser (Unused a)

type Rep (Unused a)

Defined in Network.Yak.Types

type Rep (Unused a) = D1 (MetaData "Unused" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "Unused" PrefixI False) (U1 :: Type -> Type))

class Parameter a where

Class for any kind of IRC parameter that can be rendered to ByteString and read from a ByteString

Methods

render :: a -> ByteString

seize :: Parser a

Instances

Parameter Char

Defined in Network.Yak.Types

Methods

render :: Char -> ByteString

seize :: Parser Char

Parameter Int

Only positive

Defined in Network.Yak.Types

Methods

render :: Int -> ByteString

seize :: Parser Int

Parameter Word

Defined in Network.Yak.Types

Methods

render :: Word -> ByteString

seize :: Parser Word

Parameter Host

Defined in Network.Yak.Types

Methods

render :: Host -> ByteString

seize :: Parser Host

Parameter UReply

Defined in Network.Yak.Types

Methods

render :: UReply -> ByteString

seize :: Parser UReply

Parameter Capability

Defined in Network.Yak.Capabilities

Methods

render :: Capability -> ByteString

seize :: Parser Capability

Parameter ByteString

Defined in Network.Yak.Types

Methods

render :: ByteString -> ByteString

seize :: Parser ByteString

Parameter Text

Text is encoded as UTF-8. Pieces of Text are space normally separated. Text parsing enforces the text to be non-empty, and commas are disallowed.

Defined in Network.Yak.Types

Methods

render :: Text -> ByteString

seize :: Parser Text

(TypeError (Text "Illegal IRC Parameter") :: Constraint) => Parameter Void

For illegal parameters

Defined in Network.Yak.Types

Methods

render :: Void -> ByteString

seize :: Parser Void

Parameter POSIXTime

Defined in Network.Yak.Types

Methods

render :: POSIXTime -> ByteString

seize :: Parser POSIXTime

Parameter Channel

Defined in Network.Yak.Types

Methods

render :: Channel -> ByteString

seize :: Parser Channel

Parameter Message

Defined in Network.Yak.Types

Methods

render :: Message -> ByteString

seize :: Parser Message

Parameter Modes

Defined in Network.Yak.Types

Methods

render :: Modes -> ByteString

seize :: Parser Modes

Parameter Token

Defined in Network.Yak.Types

Methods

render :: Token -> ByteString

seize :: Parser Token

Parameter ReqAnswer

Defined in Network.Yak.Capabilities

Methods

render :: ReqAnswer -> ByteString

seize :: Parser ReqAnswer

Parameter a => Parameter [a]

Lists are comma separated

Defined in Network.Yak.Types

Methods

render :: [a] -> ByteString

seize :: Parser [a]

Parameter a => Parameter (Maybe a)

A Maybe parameter can be totally absent

Defined in Network.Yak.Types

Methods

render :: Maybe a -> ByteString

seize :: Parser (Maybe a)

Parameter a => Parameter (Member a)

Defined in Network.Yak.Types

Methods

render :: Member a -> ByteString

seize :: Parser (Member a)

Parameter a => Parameter (NonEmpty a)

Like lists but non-empty

Defined in Network.Yak.Types

Methods

render :: NonEmpty a -> ByteString

seize :: Parser (NonEmpty a)

(Parameter x, Parameter (PList xs)) => Parameter (PList (x ': xs))

Defined in Network.Yak.Types

Methods

render :: PList (x ': xs) -> ByteString

seize :: Parser (PList (x ': xs))

Parameter (PList ([] :: [Type]))

Defined in Network.Yak.Types

Methods

render :: PList [] -> ByteString

seize :: Parser (PList [])

Parameter a => Parameter (CList a)

Defined in Network.Yak.Types

Methods

render :: CList a -> ByteString

seize :: Parser (CList a)

Parameter a => Parameter (SList a)

Defined in Network.Yak.Types

Methods

render :: SList a -> ByteString

seize :: Parser (SList a)

KnownSymbol a => Parameter (Unused a)

Defined in Network.Yak.Types

Methods

render :: Unused a -> ByteString

seize :: Parser (Unused a)

(Parameter a, Parameter b) => Parameter (Either a b)

Defined in Network.Yak.Types

Methods

render :: Either a b -> ByteString

seize :: Parser (Either a b)

(Parameter a, Parameter b) => Parameter (a, b)

Defined in Network.Yak.Types

Methods

render :: (a, b) -> ByteString

seize :: Parser (a, b)

KnownSymbol a => Parameter (Flag a)

Defined in Network.Yak.Types

Methods

render :: Flag a -> ByteString

seize :: Parser (Flag a)

data SomeMsg where

Constructors

SomeMsg :: (KnownSymbol c, Parameter (PList p)) => Msg c p -> SomeMsg

data Msg command params

Proxy type for holding IRC messages

Constructors

Msg

Fields

• msgPrefix :: Maybe Prefix
• msgParams :: PList params

Instances

HasHostname Motd

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Motd Hostname

HasHostname Lusers

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Lusers Hostname

HasHostname Version

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Version Hostname

HasHostname Admin

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Admin Hostname

HasHostname Time

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Time Hostname

HasHostname Stats

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Stats Hostname

HasHostname Info

Defined in Network.Yak.Client

Methods

hostname :: Traversal' Info Hostname

HasHostname WhoIs

Defined in Network.Yak.Client

Methods

hostname :: Traversal' WhoIs Hostname

HasHostname WhoWas

Defined in Network.Yak.Client

Methods

hostname :: Traversal' WhoWas Hostname

HasNick Nick

Defined in Network.Yak.Client

Methods

nick :: Traversal' Nick Nickname

HasNick Oper

Defined in Network.Yak.Client

Methods

nick :: Traversal' Oper Nickname

HasNick Mode

Defined in Network.Yak.Client

Methods

nick :: Traversal' Mode Nickname

HasNick Privmsg

Defined in Network.Yak.Client

Methods

nick :: Traversal' Privmsg Nickname

HasNick Notice

Defined in Network.Yak.Client

Methods

nick :: Traversal' Notice Nickname

HasNick WhoWas

Defined in Network.Yak.Client

Methods

nick :: Traversal' WhoWas Nickname

HasNick Kill

Defined in Network.Yak.Client

Methods

nick :: Traversal' Kill Nickname

HasNick Kick

Defined in Network.Yak.Client

Methods

nick :: Traversal' Kick Nickname

HasNick Invite

Defined in Network.Yak.Client

Methods

nick :: Traversal' Invite Nickname

HasChannel Join

Defined in Network.Yak.Client

Methods

channel :: Traversal' Join Channel

HasChannel Part

Defined in Network.Yak.Client

Methods

channel :: Traversal' Part Channel

HasChannel Topic

Defined in Network.Yak.Client

Methods

channel :: Traversal' Topic Channel

HasChannel Names

Defined in Network.Yak.Client

Methods

channel :: Traversal' Names Channel

HasChannel List

Defined in Network.Yak.Client

Methods

channel :: Traversal' List Channel

HasChannel Mode

Defined in Network.Yak.Client

Methods

channel :: Traversal' Mode Channel

HasChannel Privmsg

Defined in Network.Yak.Client

Methods

channel :: Traversal' Privmsg Channel

HasChannel Notice

Defined in Network.Yak.Client

Methods

channel :: Traversal' Notice Channel

HasChannel Kick

Defined in Network.Yak.Client

Methods

channel :: Traversal' Kick Channel

HasChannel Invite

Defined in Network.Yak.Client

Methods

channel :: Traversal' Invite Channel

Eq (PList params) => Eq (Msg command params)

Defined in Network.Yak.Types

Methods

(==) :: Msg command params -> Msg command params -> Bool

(/=) :: Msg command params -> Msg command params -> Bool

Show (PList params) => Show (Msg command params)

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Msg command params -> ShowS

show :: Msg command params -> String

showList :: [Msg command params] -> ShowS

(Parameter (PList p), KnownSymbol c) => Fetch (Msg c p)

Defined in Network.Yak

Methods

fetch :: ByteString -> Maybe (Msg c p)

data Prefix

Constructors

PrefixServer Text

PrefixUser Host

Instances

Eq Prefix

Defined in Network.Yak.Types

Methods

(==) :: Prefix -> Prefix -> Bool

(/=) :: Prefix -> Prefix -> Bool

Ord Prefix

Defined in Network.Yak.Types

Methods

compare :: Prefix -> Prefix -> Ordering

(<) :: Prefix -> Prefix -> Bool

(<=) :: Prefix -> Prefix -> Bool

(>) :: Prefix -> Prefix -> Bool

(>=) :: Prefix -> Prefix -> Bool

max :: Prefix -> Prefix -> Prefix

min :: Prefix -> Prefix -> Prefix

Read Prefix

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS Prefix

readList :: ReadS [Prefix]

readPrec :: ReadPrec Prefix

readListPrec :: ReadPrec [Prefix]

Show Prefix

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Prefix -> ShowS

show :: Prefix -> String

showList :: [Prefix] -> ShowS

Generic Prefix

Defined in Network.Yak.Types

Associated Types

type Rep Prefix :: Type -> Type

Methods

from :: Prefix -> Rep Prefix x

to :: Rep Prefix x -> Prefix

type Rep Prefix

Defined in Network.Yak.Types

type Rep Prefix = D1 (MetaData "Prefix" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "PrefixServer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "PrefixUser" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Host)))

phead :: Parameter x' => Lens (PList (x ': xs)) (PList (x' ': xs)) x x'

ptail :: Lens (PList (x ': xs)) (PList (x ': xs')) (PList xs) (PList xs')

newtype Channel

Constructors

Channel

Fields

• getChannel :: Text

Instances

Eq Channel

Defined in Network.Yak.Types

Methods

(==) :: Channel -> Channel -> Bool

(/=) :: Channel -> Channel -> Bool

Ord Channel

Defined in Network.Yak.Types

Methods

compare :: Channel -> Channel -> Ordering

(<) :: Channel -> Channel -> Bool

(<=) :: Channel -> Channel -> Bool

(>) :: Channel -> Channel -> Bool

(>=) :: Channel -> Channel -> Bool

max :: Channel -> Channel -> Channel

min :: Channel -> Channel -> Channel

Read Channel

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS Channel

readList :: ReadS [Channel]

readPrec :: ReadPrec Channel

readListPrec :: ReadPrec [Channel]

Show Channel

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

IsString Channel

Defined in Network.Yak.Types

Methods

fromString :: String -> Channel

Generic Channel

Defined in Network.Yak.Types

Associated Types

type Rep Channel :: Type -> Type

Methods

from :: Channel -> Rep Channel x

to :: Rep Channel x -> Channel

Semigroup Channel

Defined in Network.Yak.Types

Methods

(<>) :: Channel -> Channel -> Channel

sconcat :: NonEmpty Channel -> Channel

stimes :: Integral b => b -> Channel -> Channel

Monoid Channel

Defined in Network.Yak.Types

Methods

mempty :: Channel

mappend :: Channel -> Channel -> Channel

mconcat :: [Channel] -> Channel

Wrapped Channel

Defined in Network.Yak.Types

Associated Types

type Unwrapped Channel :: Type

Methods

_Wrapped' :: Iso' Channel (Unwrapped Channel)

Parameter Channel

Defined in Network.Yak.Types

Methods

render :: Channel -> ByteString

seize :: Parser Channel

HasNick Mode

Defined in Network.Yak.Client

Methods

nick :: Traversal' Mode Nickname

HasNick Privmsg

Defined in Network.Yak.Client

Methods

nick :: Traversal' Privmsg Nickname

HasNick Notice

Defined in Network.Yak.Client

Methods

nick :: Traversal' Notice Nickname

HasNick Kick

Defined in Network.Yak.Client

Methods

nick :: Traversal' Kick Nickname

HasNick Invite

Defined in Network.Yak.Client

Methods

nick :: Traversal' Invite Nickname

HasChannel Join

Defined in Network.Yak.Client

Methods

channel :: Traversal' Join Channel

HasChannel Part

Defined in Network.Yak.Client

Methods

channel :: Traversal' Part Channel

HasChannel Topic

Defined in Network.Yak.Client

Methods

channel :: Traversal' Topic Channel

HasChannel Names

Defined in Network.Yak.Client

Methods

channel :: Traversal' Names Channel

HasChannel List

Defined in Network.Yak.Client

Methods

channel :: Traversal' List Channel

HasChannel Mode

Defined in Network.Yak.Client

Methods

channel :: Traversal' Mode Channel

HasChannel Privmsg

Defined in Network.Yak.Client

Methods

channel :: Traversal' Privmsg Channel

HasChannel Notice

Defined in Network.Yak.Client

Methods

channel :: Traversal' Notice Channel

HasChannel Kick

Defined in Network.Yak.Client

Methods

channel :: Traversal' Kick Channel

HasChannel Invite

Defined in Network.Yak.Client

Methods

channel :: Traversal' Invite Channel

Channel ~ t => Rewrapped Channel t

Defined in Network.Yak.Types

type Rep Channel

Defined in Network.Yak.Types

type Rep Channel = D1 (MetaData "Channel" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" True) (C1 (MetaCons "Channel" PrefixI True) (S1 (MetaSel (Just "getChannel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Unwrapped Channel

Defined in Network.Yak.Types

type Unwrapped Channel = Text

params :: forall command params command params. Lens (Msg command params) (Msg command params) (PList params) (PList params)

prefix :: forall command params command. Lens (Msg command params) (Msg command params) (Maybe Prefix) (Maybe Prefix)

newtype Message

Constructors

Message

Fields

• getMessage :: Text

Instances

Eq Message

Defined in Network.Yak.Types

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Ord Message

Defined in Network.Yak.Types

Methods

compare :: Message -> Message -> Ordering

(<) :: Message -> Message -> Bool

(<=) :: Message -> Message -> Bool

(>) :: Message -> Message -> Bool

(>=) :: Message -> Message -> Bool

max :: Message -> Message -> Message

min :: Message -> Message -> Message

Read Message

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS Message

readList :: ReadS [Message]

readPrec :: ReadPrec Message

readListPrec :: ReadPrec [Message]

Show Message

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

IsString Message

Defined in Network.Yak.Types

Methods

fromString :: String -> Message

Generic Message

Defined in Network.Yak.Types

Associated Types

type Rep Message :: Type -> Type

Methods

from :: Message -> Rep Message x

to :: Rep Message x -> Message

Semigroup Message

Defined in Network.Yak.Types

Methods

(<>) :: Message -> Message -> Message

sconcat :: NonEmpty Message -> Message

stimes :: Integral b => b -> Message -> Message

Monoid Message

Defined in Network.Yak.Types

Methods

mempty :: Message

mappend :: Message -> Message -> Message

mconcat :: [Message] -> Message

Wrapped Message

Defined in Network.Yak.Types

Associated Types

type Unwrapped Message :: Type

Methods

_Wrapped' :: Iso' Message (Unwrapped Message)

Parameter Message

Defined in Network.Yak.Types

Methods

render :: Message -> ByteString

seize :: Parser Message

HasNick Privmsg

Defined in Network.Yak.Client

Methods

nick :: Traversal' Privmsg Nickname

HasNick Notice

Defined in Network.Yak.Client

Methods

nick :: Traversal' Notice Nickname

HasNick Kill

Defined in Network.Yak.Client

Methods

nick :: Traversal' Kill Nickname

HasNick Kick

Defined in Network.Yak.Client

Methods

nick :: Traversal' Kick Nickname

HasChannel Part

Defined in Network.Yak.Client

Methods

channel :: Traversal' Part Channel

HasChannel Topic

Defined in Network.Yak.Client

Methods

channel :: Traversal' Topic Channel

HasChannel Privmsg

Defined in Network.Yak.Client

Methods

channel :: Traversal' Privmsg Channel

HasChannel Notice

Defined in Network.Yak.Client

Methods

channel :: Traversal' Notice Channel

HasChannel Kick

Defined in Network.Yak.Client

Methods

channel :: Traversal' Kick Channel

Message ~ t => Rewrapped Message t

Defined in Network.Yak.Types

type Rep Message

Defined in Network.Yak.Types

type Rep Message = D1 (MetaData "Message" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" True) (C1 (MetaCons "Message" PrefixI True) (S1 (MetaSel (Just "getMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Unwrapped Message

Defined in Network.Yak.Types

type Unwrapped Message = Text

newtype Modes

Constructors

Modes

Fields

• getModes :: [Char]

Instances

Generic Modes

Defined in Network.Yak.Types

Associated Types

type Rep Modes :: Type -> Type

Methods

from :: Modes -> Rep Modes x

to :: Rep Modes x -> Modes

Wrapped Modes

Defined in Network.Yak.Types

Associated Types

type Unwrapped Modes :: Type

Methods

_Wrapped' :: Iso' Modes (Unwrapped Modes)

Parameter Modes

Defined in Network.Yak.Types

Methods

render :: Modes -> ByteString

seize :: Parser Modes

Modes ~ t => Rewrapped Modes t

Defined in Network.Yak.Types

type Rep Modes

Defined in Network.Yak.Types

type Rep Modes = D1 (MetaData "Modes" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" True) (C1 (MetaCons "Modes" PrefixI True) (S1 (MetaSel (Just "getModes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Char])))

type Unwrapped Modes

Defined in Network.Yak.Types

type Unwrapped Modes = [Char]

data Token

Constructors

KeyValue Text Text

PositiveToken Text

NegativeToken Text

Instances

Eq Token

Defined in Network.Yak.Types

Methods

(==) :: Token -> Token -> Bool

(/=) :: Token -> Token -> Bool

Ord Token

Defined in Network.Yak.Types

Methods

compare :: Token -> Token -> Ordering

(<) :: Token -> Token -> Bool

(<=) :: Token -> Token -> Bool

(>) :: Token -> Token -> Bool

(>=) :: Token -> Token -> Bool

max :: Token -> Token -> Token

min :: Token -> Token -> Token

Read Token

Defined in Network.Yak.Types

Methods

readsPrec :: Int -> ReadS Token

readList :: ReadS [Token]

readPrec :: ReadPrec Token

readListPrec :: ReadPrec [Token]

Show Token

Defined in Network.Yak.Types

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Generic Token

Defined in Network.Yak.Types

Associated Types

type Rep Token :: Type -> Type

Methods

from :: Token -> Rep Token x

to :: Rep Token x -> Token

Parameter Token

Defined in Network.Yak.Types

Methods

render :: Token -> ByteString

seize :: Parser Token

type Rep Token

Defined in Network.Yak.Types

type Rep Token = D1 (MetaData "Token" "Network.Yak.Types" "yak-0.2.0.0-DpGRvARnWRP1pvWDPQg9Pa" False) (C1 (MetaCons "KeyValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: (C1 (MetaCons "PositiveToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "NegativeToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))