Tor.DataFormat.Helpers

Miscellaneous very useful parsing routines.

Documentation

data PortSpec

A port specifier

Constructors

PortSpecAll

Accept any port

PortSpecRange Word16 Word16

Accept ports between the two values, inclusive.

PortSpecSingle Word16

Accept only the given port.

Instances

Eq PortSpec

Show PortSpec

data AddrSpec

An address or subnet specifier.

Constructors

AddrSpecAll

Accept any address

AddrSpecIP4 String

Accept this specific address.

AddrSpecIP4Mask String String

Accept this IP address and subnet mask (255.255.255.0,etc.)

AddrSpecIP4Bits String Int

Accept this IP address and CIDR mask (/24,etc.)

AddrSpecIP6 String

Accept this specific IP6 address.

AddrSpecIP6Bits String Int

Accept this subnet and CIDR mask.

Instances

Eq AddrSpec

Show AddrSpec

standardLine :: String -> Parser a -> Parser a

Parse a standard line of "name thingn".

nickname :: Parser String

Parse a Tor nickname.

hexDigest :: Parser ByteString

Parse a 20 byte hex digest.

port :: Bool -> Parser Word16

Parse a port number.

addrSpec :: Parser AddrSpec

Parse an address specifier.

portSpec :: Parser PortSpec

Parse a port specifier

ip4 :: Parser String

Parse an IPv4 address.

ip6 :: Parser String

Parse an IPv6 address; assuming [0000:1111:....] format, with braces.

publicKey :: Parser PublicKey

Parse a public key.

publicKey' :: Parser (PublicKey, ByteString)

Parse a public key. Returns both the public key and the raw data behind it.

utcTime :: Parser DateTime

Parse a timestamp in UTC format.

bool :: Parser Bool

Parse a boolean. (0/1)

char8 :: Char -> Parser Word8

Parse a character.

alphaNum :: Parser Word8

Parse an alphanumeric character.

decDigit :: Parser Word8

Parse a decimal digit.

hexDigit :: Parser Word8

Parse a hex digit.

base64Char :: Parser Word8

Parse a character in a Base64 stream.

decimalNum :: (Integral a, Read a) => (a -> Bool) -> Parser a

Parse a decimal number that matches the given predicate.

whitespace :: Parser ()

Eat up some whitespace.

whitespace1 :: Parser ()

Eat up at least one character of whitespace.

sp :: Parser Word8

Read a space.

nl :: Parser Word8

Read a newline.

newline :: Parser ()

Eat some amount of whitespace and then a newline.

toString :: [Word8] -> String

Convert a series of bytes into a character string.

readHex :: String -> ByteString

Read a hex number into a bytestring in the obvious way.

decodeBase64 :: [Word8] -> Parser ByteString

Decode a series of characters as a Base64 stream.