Safe Haskell	None
Language	Haskell2010

Data.ByteString.Base64.Type

Description

Strict ByteString standard base64 encoding.

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

Synopsis

data ByteString64
makeByteString64 :: ByteString -> ByteString64
getByteString64 :: ByteString64 -> ByteString
mkBS64 :: ByteString -> ByteString64
getBS64 :: ByteString64 -> ByteString
getEncodedByteString64 :: ByteString64 -> ByteString

Documentation

data ByteString64 Source #

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

Instances details

Eq ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods (==) :: ByteString64 -> ByteString64 -> Bool Source # (/=) :: ByteString64 -> ByteString64 -> Bool Source #
Data ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> ByteString64 -> c ByteString64 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ByteString64 Source # toConstr :: ByteString64 -> Constr Source # dataTypeOf :: ByteString64 -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ByteString64 ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ByteString64 ) Source # gmapT :: ( forall b. Data b => b -> b) -> ByteString64 -> ByteString64 Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ByteString64 -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ByteString64 -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ByteString64 -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ByteString64 -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ByteString64 -> m ByteString64 Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ByteString64 -> m ByteString64 Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ByteString64 -> m ByteString64 Source #
Ord ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods compare :: ByteString64 -> ByteString64 -> Ordering Source # (<) :: ByteString64 -> ByteString64 -> Bool Source # (<=) :: ByteString64 -> ByteString64 -> Bool Source # (>) :: ByteString64 -> ByteString64 -> Bool Source # (>=) :: ByteString64 -> ByteString64 -> Bool Source # max :: ByteString64 -> ByteString64 -> ByteString64 Source # min :: ByteString64 -> ByteString64 -> ByteString64 Source #
Show ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods showsPrec :: Int -> ByteString64 -> ShowS Source # show :: ByteString64 -> String Source # showList :: [ ByteString64 ] -> ShowS Source #
IsString ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods fromString :: String -> ByteString64 Source #
Generic ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Associated Types type Rep ByteString64 :: Type -> Type Source # Methods from :: ByteString64 -> Rep ByteString64 x Source # to :: Rep ByteString64 x -> ByteString64 Source #
Semigroup ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods (<>) :: ByteString64 -> ByteString64 -> ByteString64 Source # sconcat :: NonEmpty ByteString64 -> ByteString64 Source # stimes :: Integral b => b -> ByteString64 -> ByteString64 Source #
Monoid ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods mempty :: ByteString64 Source # mappend :: ByteString64 -> ByteString64 -> ByteString64 Source # mconcat :: [ ByteString64 ] -> ByteString64 Source #
Function ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods function :: ( ByteString64 -> b) -> ByteString64 :-> b Source #
Arbitrary ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods arbitrary :: Gen ByteString64 Source # shrink :: ByteString64 -> [ ByteString64 ] Source #
CoArbitrary ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods coarbitrary :: ByteString64 -> Gen b -> Gen b Source #
Hashable ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods hashWithSalt :: Int -> ByteString64 -> Int Source # hash :: ByteString64 -> Int Source #
ToJSON ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods toJSON :: ByteString64 -> Value Source # toEncoding :: ByteString64 -> Encoding Source # toJSONList :: [ ByteString64 ] -> Value Source # toEncodingList :: [ ByteString64 ] -> Encoding Source #
ToJSONKey ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods toJSONKey :: ToJSONKeyFunction ByteString64 Source # toJSONKeyList :: ToJSONKeyFunction [ ByteString64 ] Source #
FromJSON ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods parseJSON :: Value -> Parser ByteString64 Source # parseJSONList :: Value -> Parser [ ByteString64 ] Source #
FromJSONKey ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods fromJSONKey :: FromJSONKeyFunction ByteString64 Source # fromJSONKeyList :: FromJSONKeyFunction [ ByteString64 ] Source #
Binary ByteString64 Source #	`ByteString64` is serialised as `ByteString` `>>>` `Binary.encode (mkBS64 "foobar")`"\NUL\NUL\NUL\NUL\NUL\NUL\NUL\ACKfoobar"
Instance details Defined in Data.ByteString.Base64.Type Methods put :: ByteString64 -> Put Source # get :: Get ByteString64 Source # putList :: [ ByteString64 ] -> Put Source #
Serialize ByteString64 Source #	`ByteString64` is serialised as `ByteString` `>>>` `Cereal.encode (mkBS64 "foobar")`"\NUL\NUL\NUL\NUL\NUL\NUL\NUL\ACKfoobar"
Instance details Defined in Data.ByteString.Base64.Type Methods put :: Putter ByteString64 Source # get :: Get ByteString64 Source #
NFData ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods rnf :: ByteString64 -> () Source #
ToHttpApiData ByteString64 Source #	`>>>` `HTTP.toUrlPiece (mkBS64 $ pack [164..192])`"pKWmp6ipqqusra6vsLGys7S1tre4ubq7vL2+v8A=" Note: the plus in the encoding. Consider using Data.ByteString.Base64.URL.Type variant.
Instance details Defined in Data.ByteString.Base64.Type Methods toUrlPiece :: ByteString64 -> Text Source # toEncodedUrlPiece :: ByteString64 -> Builder Source # toHeader :: ByteString64 -> ByteString Source # toQueryParam :: ByteString64 -> Text Source #
FromHttpApiData ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type Methods parseUrlPiece :: Text -> Either Text ByteString64 Source # parseHeader :: ByteString -> Either Text ByteString64 Source # parseQueryParam :: Text -> Either Text ByteString64 Source #
Serialise ByteString64 Source #	`>>>` `Serialise.serialise (mkBS64 "xyzzy")`"Exyzzy"
Instance details Defined in Data.ByteString.Base64.Type Methods encode :: ByteString64 -> Encoding Source # decode :: Decoder s ByteString64 Source # encodeList :: [ ByteString64 ] -> Encoding Source # decodeList :: Decoder s [ ByteString64 ] Source #
type Rep ByteString64 Source #
Instance details Defined in Data.ByteString.Base64.Type type Rep ByteString64 = D1 (' MetaData "ByteString64" "Data.ByteString.Base64.Type" "base64-bytestring-type-1.0.1-79EWs4GzwM7By4hPpYj75d" ' True ) ( C1 (' MetaCons "BS64" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )))

makeByteString64 :: ByteString -> ByteString64 Source #

Wrap ByteString into ByteString64 . Essentially coerce .

getByteString64 :: ByteString64 -> ByteString Source #

Unwrap ByteString from ByteString64 . Essentially coerce .

mkBS64 :: ByteString -> ByteString64 Source #

Shorter variant of makeByteString64

getBS64 :: ByteString64 -> ByteString Source #

getEncodedByteString64 :: ByteString64 -> ByteString Source #

Get base64 encode bytestring

>>> getEncodedByteString64 "foobar"
"Zm9vYmFy"

>>> getEncodedByteString64 "aa\191"
"YWG/"