Text.Damn.Packet

Provides convenience functions for manipulating dAmn packets.

The Packet datatype

data Packet

Represents a dAmn packet.

Packets are comprised of a command, which is mandatory, and three other optional elements: a "parameter", an argument list, and a body. Any combination of the latter three (or none of them) is valid, so the parser is fairly lenient.

A packet with all four elements will look something like this:

property chat:SomeChatroom
p=propertyName
by=name of setter
ts=timestamp

value of property

Parsing this results in the packet:

Packet { pktCommand = "property"
       , pktParameter = Just "chat:SomeChatroom"
       , pktArgs = fromList [("p","propertyName"),("by","name of setter"),("ts","timestamp")]
       , pktBody = Just "value of property"
       }

Constructors

Packet

Fields

pktCommand :: Text

pktParameter :: Maybe Text

pktArgs :: Arguments

pktBody :: Maybe Text

Instances

Eq Packet

Data Packet

Show Packet

Typeable Packet

NFData Packet

type Arguments = Map Text Text

A type synonym--because pressing spacebar is pretty irritating.

Subpackets

pktSubpacket :: Packet -> Either String Packet

Due to the way dAmn packets are designed, it's not possible to unambiguously determine whether a packet has a subpacket or just a body. Thus you will need to request a subpacket yourself.

pktSubpacket' :: Packet -> Maybe Packet

Use when you don't care about the reason for parse failure.

Packet lenses

pktCommandL :: Functor f => (Text -> f Text) -> Packet -> f Packet

A lens on pktCommand.

pktParameterL :: Functor f => (Maybe Text -> f (Maybe Text)) -> Packet -> f Packet

A lens on pktParameter.

pktArgsL :: Functor f => (Arguments -> f Arguments) -> Packet -> f Packet

A lens on pktArgs.

pktBodyL :: Functor f => (Maybe Text -> f (Maybe Text)) -> Packet -> f Packet

A lens on pktBody.

pktSubpacketL :: Functor f => (Maybe Packet -> f (Maybe Packet)) -> Packet -> f Packet

A lens on pktSubpacket'.

Parsing

parse :: Text -> Either String Packet

Parse some text, providing a packet or the reason for parse failure.

parse' :: Text -> Maybe Packet

Parse some text, discarding any failure message.

Rendering packets

render :: Packet -> Text

render converts a packet back into the dAmn text format. This is used by pktSubpacketL to fulfill the lens laws, but you might find it useful if you want to write packets to dAmn.