Data.ByteString.Base64.URL.Type

Strict ByteString base64 encoding with URL and filename safe alphabet.

See https://tools.ietf.org/html/rfc4648.

Documentation

data ByteString64

Aeson serialisable bytestring. Uses base64 encoding.

The inner ByteString is in raw format.

>>> let bs64 = makeByteString64 "foobar"
>>> bs64
mkBS64 "foobar"

Binary instance doesn't use base64 encoding:

>>> Binary.encode bs64
"\NUL\NUL\NUL\NUL\NUL\NUL\NUL\ACKfoobar"

Aeson instance does:

>>> Aeson.encode bs64
"\"Zm9vYmFy\""

This module uses standard alphabet

>>> Aeson.encode (makeByteString64 "aa\191")
"\"YWG_\""

Instances

Eq ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

(==) :: ByteString64 -> ByteString64 -> Bool

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

Data ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteString64 -> c ByteString64

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteString64

toConstr :: ByteString64 -> Constr

dataTypeOf :: ByteString64 -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteString64)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteString64)

gmapT :: (forall b. Data b => b -> b) -> ByteString64 -> ByteString64

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteString64 -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteString64 -> r

gmapQ :: (forall d. Data d => d -> u) -> ByteString64 -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteString64 -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteString64 -> m ByteString64

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString64 -> m ByteString64

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteString64 -> m ByteString64

Ord ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

compare :: ByteString64 -> ByteString64 -> Ordering

(<) :: ByteString64 -> ByteString64 -> Bool

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

(>) :: ByteString64 -> ByteString64 -> Bool

(>=) :: ByteString64 -> ByteString64 -> Bool

max :: ByteString64 -> ByteString64 -> ByteString64

min :: ByteString64 -> ByteString64 -> ByteString64

Show ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

showsPrec :: Int -> ByteString64 -> ShowS

show :: ByteString64 -> String

showList :: [ByteString64] -> ShowS

IsString ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

fromString :: String -> ByteString64

Generic ByteString64

Defined in Data.ByteString.Base64.URL.Type

Associated Types

type Rep ByteString64 :: Type -> Type

Methods

from :: ByteString64 -> Rep ByteString64 x

to :: Rep ByteString64 x -> ByteString64

Semigroup ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

(<>) :: ByteString64 -> ByteString64 -> ByteString64

sconcat :: NonEmpty ByteString64 -> ByteString64

stimes :: Integral b => b -> ByteString64 -> ByteString64

Monoid ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

mempty :: ByteString64

mappend :: ByteString64 -> ByteString64 -> ByteString64

mconcat :: [ByteString64] -> ByteString64

Function ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

function :: (ByteString64 -> b) -> ByteString64 :-> b

Arbitrary ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

arbitrary :: Gen ByteString64

shrink :: ByteString64 -> [ByteString64]

CoArbitrary ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

coarbitrary :: ByteString64 -> Gen b -> Gen b

Hashable ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

hashWithSalt :: Int -> ByteString64 -> Int

hash :: ByteString64 -> Int

ToJSON ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

toJSON :: ByteString64 -> Value

toEncoding :: ByteString64 -> Encoding

toJSONList :: [ByteString64] -> Value

toEncodingList :: [ByteString64] -> Encoding

ToJSONKey ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

toJSONKey :: ToJSONKeyFunction ByteString64

toJSONKeyList :: ToJSONKeyFunction [ByteString64]

FromJSON ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

parseJSON :: Value -> Parser ByteString64

parseJSONList :: Value -> Parser [ByteString64]

FromJSONKey ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

fromJSONKey :: FromJSONKeyFunction ByteString64

fromJSONKeyList :: FromJSONKeyFunction [ByteString64]

Binary ByteString64

ByteString64 is serialised as ByteString

>>> Binary.encode (mkBS64 "foobar")
"\NUL\NUL\NUL\NUL\NUL\NUL\NUL\ACKfoobar"

Defined in Data.ByteString.Base64.URL.Type

Methods

put :: ByteString64 -> Put

get :: Get ByteString64

putList :: [ByteString64] -> Put

Serialize ByteString64

ByteString64 is serialised as ByteString

>>> Cereal.encode (mkBS64 "foobar")
"\NUL\NUL\NUL\NUL\NUL\NUL\NUL\ACKfoobar"

Defined in Data.ByteString.Base64.URL.Type

Methods

put :: Putter ByteString64

get :: Get ByteString64

NFData ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

rnf :: ByteString64 -> ()

ToHttpApiData ByteString64

>>> HTTP.toUrlPiece (mkBS64 $ pack [164..192])
"pKWmp6ipqqusra6vsLGys7S1tre4ubq7vL2-v8A="

Defined in Data.ByteString.Base64.URL.Type

Methods

toUrlPiece :: ByteString64 -> Text

toEncodedUrlPiece :: ByteString64 -> Builder

toHeader :: ByteString64 -> ByteString

toQueryParam :: ByteString64 -> Text

FromHttpApiData ByteString64

Defined in Data.ByteString.Base64.URL.Type

Methods

parseUrlPiece :: Text -> Either Text ByteString64

parseHeader :: ByteString -> Either Text ByteString64

parseQueryParam :: Text -> Either Text ByteString64

Serialise ByteString64

>>> Serialise.serialise (mkBS64 "xyzzy")
"Exyzzy"

Defined in Data.ByteString.Base64.URL.Type

Methods

encode :: ByteString64 -> Encoding

decode :: Decoder s ByteString64

encodeList :: [ByteString64] -> Encoding

decodeList :: Decoder s [ByteString64]

type Rep ByteString64

Defined in Data.ByteString.Base64.URL.Type

type Rep ByteString64 = D1 (MetaData "ByteString64" "Data.ByteString.Base64.URL.Type" "base64-bytestring-type-1.0.1-JRgEVtUaTwmCogSCAy8IH7" True) (C1 (MetaCons "BS64" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

makeByteString64 :: ByteString -> ByteString64

Wrap ByteString into ByteString64. Essentially coerce.

getByteString64 :: ByteString64 -> ByteString

Unwrap ByteString from ByteString64. Essentially coerce.

mkBS64 :: ByteString -> ByteString64

Shorter variant of makeByteString64

getBS64 :: ByteString64 -> ByteString

getEncodedByteString64 :: ByteString64 -> ByteString

Get base64 encode bytestring

>>> getEncodedByteString64 "foobar"
"Zm9vYmFy"

>>> getEncodedByteString64 "aa\191"
"YWG_"