Codec.MIME.ContentType.Text.Directory

Library for parsing and generating the text/directory mime content type. This library implements all the required mechanisms in RFC 2425, which other libraries may use to implement parsing and generating specific profiles, such as vCard.

Types

type Directory u = [Map Type [Property u]]

A directory is a list of groups of semantically related entities. These entities are grouped together in RFC 2425 using BEGIN ... END pairs. Within a group properties are further grouped together by the property types.

data Property u

Constructors

Prop

Fields

prop_type :: Type

prop_parameters :: [Parameter]

prop_value :: Value u

Instances

Show u => Show (Property u)

data Type

Constructors

Type

Fields

type_group :: Maybe ByteString

type_name :: ByteString

Instances

Eq Type

Ord Type

Show Type

data Parameter

Constructors

Param

Fields

param_name :: ByteString

param_values :: [ByteString]

Instances

Show Parameter

data Value u

This is sufficient to represent values whose specification is defined in RFC 2425. Values with other specifications can be represented via the IANAValue constructor.

Constructors

URI URI

Text ByteString

Date Day

Time DiffTime

DateTime UTCTime

Integer Integer

Boolean Bool

Float Float

IANAValue u

An IANA defined type not part of rfc2425

Instances

Eq u => Eq (Value u)

Show u => Show (Value u)

PrintValue u => PrintValue (Value u)

data Rfc2425Value

Instantiate Value with this phantom type to indicate that property types should be none other than those defined in rfc2425.

Instances

Show Rfc2425Value

PrintValue Rfc2425Value

class PrintValue a where

Methods

printValue :: a -> ByteString

Instances

PrintValue Rfc2425Value

PrintValue u => PrintValue (Value u)

type ValueParser u = (Type, [Parameter]) -> ByteString -> [Value u]

The type of parsers for property values, for instance to read an integer property, text property, etc.

nakedType :: ByteString -> Type

Make a property type without any grouping.

(@@) :: Property u -> ByteString -> Bool

Check whether the given property is an instance of the given type.

lookupParameter :: ByteString -> [Parameter] -> Maybe [ByteString]

Find the parameter values for a given parameter name.

Encoding/decoding values

decodeValue :: [Parameter] -> ByteString -> ByteString

Properties may indicate an encoding, so this decodes the value if need be before parsing.

encodeValue :: [Parameter] -> ByteString -> ByteString

Properties may indicate an encoding, so this encodes the value if need be after printing.

escape :: ByteString -> ByteString -> ByteString

Escape any occurrence of the characters given as first argument with a backslash. Newlines are always replaced by the two character sequence "\n". The backslash character is always escaped.

Parsing

parseDirectory

Arguments

:: ValueParser u

Given a Property Type and a list of parameters, parse a string representation into a Value.

-> ByteString

-> Directory u

Produces a map where properties are grouped together using their type as key.

parseDirectory' :: ValueParser u -> ByteString -> [Property u]

An alternative version of parseDirectory that produces a list of properties rather than a mapping from property types to properties. Note that here properties in the list are in the same order as in the input string.

fromList :: [Property u] -> Directory u

Build a directory from a list of properties.

groupByBeginEnd :: [Property u] -> [[Property u]]

Group properties into blocks delimited by begin..end pairs.

Value Parsers

pa_URI :: ValueParser u

pa_text :: ValueParser u

Unescape slashes, newlines and commas.

pa_date :: ValueParser u

pa_time :: ValueParser u

pa_dateTime :: ValueParser u

pa_integer :: ValueParser u

pa_boolean :: ValueParser u

pa_float :: ValueParser u

pa_textList :: ValueParser u

Value parser combinators

many :: ValueParser u -> ValueParser u

Take a parser for single values to a parser for a list of values. This assumes that the separator between values is the "," character, and that values do not contain commas themselves.

Printing

printDirectory :: PrintValue u => Directory u -> ByteString

printDirectory' :: PrintValue u => [Property u] -> ByteString

printProperty :: PrintValue u => Property u -> ByteString