Network.Riak.Escape

Support for REST-safe name handling.

Riak's protocol buffer (PBC) API will accept unescaped bucket, link, and key names. Its REST API does not unescape names, so it is possible to use the PBC API to construct names that cannot be accessed via the REST API (e.g. containing an embedded slash or other URL-unsafe octet).

Documentation

class Escape e where

The class of string-like types that can be URL-escaped and unescaped.

Minimal complete definition

escape, unescape'

Methods

escape :: e -> ByteString

URL-escape a string.

unescape' :: ByteString -> Either String e

URL-unescape a string.

Instances

Escape ByteString

Methods

escape :: ByteString -> ByteString

unescape' :: ByteString -> Either String ByteString

Escape ByteString

Methods

escape :: ByteString -> ByteString

unescape' :: ByteString -> Either String ByteString

Escape Text

Methods

escape :: Text -> ByteString

unescape' :: ByteString -> Either String Text

Escape Text

Methods

escape :: Text -> ByteString

unescape' :: ByteString -> Either String Text

Escape [Char]

Methods

escape :: [Char] -> ByteString

unescape' :: ByteString -> Either String [Char]

unescape :: Escape e => ByteString -> e

URL-unescape a string that is presumed to be properly escaped. If the string is invalid, an error will be thrown that cannot be caught from pure code.