Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.Data.Body

Description

Synopsis

newtype RsBody = RsBody {
- _streamBody :: ConduitM () ByteString (ResourceT IO) ()
}
fuseStream :: RsBody -> ConduitM ByteString ByteString (ResourceT IO) () -> RsBody
newtype ChunkSize = ChunkSize Int
defaultChunkSize :: ChunkSize
data ChunkedBody = ChunkedBody {
- _chunkedSize :: !ChunkSize
- _chunkedLength :: !Integer
- _chunkedBody :: ConduitM () ByteString (ResourceT IO) ()
}
chunkedLength :: Lens' ChunkedBody Integer
fuseChunks :: ChunkedBody -> ConduitM ByteString ByteString (ResourceT IO) () -> ChunkedBody
fullChunks :: ChunkedBody -> Integer
remainderBytes :: ChunkedBody -> Maybe Integer
data HashedBody
- = HashedStream (Digest SHA256) !Integer (ConduitM () ByteString (ResourceT IO) ())
- | HashedBytes (Digest SHA256) ByteString
sha256Base16 :: HashedBody -> ByteString
data RqBody
- = Chunked ChunkedBody
- | Hashed HashedBody
md5Base64 :: RqBody -> Maybe ByteString
isStreaming :: RqBody -> Bool
toRequestBody :: RqBody -> RequestBody
contentLength :: RqBody -> Integer
class ToHashedBody a where
- toHashed :: a -> HashedBody
class ToBody a where
- toBody :: a -> RqBody
_Body :: ToBody a => AReview RqBody a

Documentation

newtype RsBody Source #

A streaming, exception safe response body.

Constructors

RsBody
Fields _streamBody :: ConduitM () ByteString (ResourceT IO) ()

Instances

Show RsBody Source #
Instance details Defined in Network.AWS.Data.Body Methods showsPrec :: Int -> RsBody -> ShowS # show :: RsBody -> String # showList :: [RsBody] -> ShowS #

fuseStream :: RsBody -> ConduitM ByteString ByteString (ResourceT IO) () -> RsBody Source #

newtype ChunkSize Source #

Specifies the transmitted size of the 'Transfer-Encoding' chunks.

See: defaultChunk.

Constructors

ChunkSize Int

Instances

Enum ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods succ :: ChunkSize -> ChunkSize # pred :: ChunkSize -> ChunkSize # toEnum :: Int -> ChunkSize # fromEnum :: ChunkSize -> Int # enumFrom :: ChunkSize -> [ChunkSize] # enumFromThen :: ChunkSize -> ChunkSize -> [ChunkSize] # enumFromTo :: ChunkSize -> ChunkSize -> [ChunkSize] # enumFromThenTo :: ChunkSize -> ChunkSize -> ChunkSize -> [ChunkSize] #
Eq ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods (==) :: ChunkSize -> ChunkSize -> Bool # (/=) :: ChunkSize -> ChunkSize -> Bool #
Integral ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods quot :: ChunkSize -> ChunkSize -> ChunkSize # rem :: ChunkSize -> ChunkSize -> ChunkSize # div :: ChunkSize -> ChunkSize -> ChunkSize # mod :: ChunkSize -> ChunkSize -> ChunkSize # quotRem :: ChunkSize -> ChunkSize -> (ChunkSize, ChunkSize) # divMod :: ChunkSize -> ChunkSize -> (ChunkSize, ChunkSize) # toInteger :: ChunkSize -> Integer #
Num ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods (+) :: ChunkSize -> ChunkSize -> ChunkSize # (-) :: ChunkSize -> ChunkSize -> ChunkSize # (*) :: ChunkSize -> ChunkSize -> ChunkSize # negate :: ChunkSize -> ChunkSize # abs :: ChunkSize -> ChunkSize # signum :: ChunkSize -> ChunkSize # fromInteger :: Integer -> ChunkSize #
Ord ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods compare :: ChunkSize -> ChunkSize -> Ordering # (<) :: ChunkSize -> ChunkSize -> Bool # (<=) :: ChunkSize -> ChunkSize -> Bool # (>) :: ChunkSize -> ChunkSize -> Bool # (>=) :: ChunkSize -> ChunkSize -> Bool # max :: ChunkSize -> ChunkSize -> ChunkSize # min :: ChunkSize -> ChunkSize -> ChunkSize #
Real ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods toRational :: ChunkSize -> Rational #
Show ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods showsPrec :: Int -> ChunkSize -> ShowS # show :: ChunkSize -> String # showList :: [ChunkSize] -> ShowS #
ToLog ChunkSize Source #
Instance details Defined in Network.AWS.Data.Body Methods build :: ChunkSize -> Builder Source #

defaultChunkSize :: ChunkSize Source #

The default chunk size of 128 KB. The minimum chunk size accepted by AWS is 8 KB, unless the entirety of the request is below this threshold.

A chunk size of 64 KB or higher is recommended for performance reasons.

data ChunkedBody Source #

An opaque request body which will be transmitted via Transfer-Encoding: chunked.

Invariant: Only services that support chunked encoding can accept a ChunkedBody. (Currently S3.) This is enforced by the type signatures emitted by the generator.

Constructors

ChunkedBody
Fields _chunkedSize :: !ChunkSize _chunkedLength :: !Integer _chunkedBody :: ConduitM () ByteString (ResourceT IO) ()

Instances

Show ChunkedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods showsPrec :: Int -> ChunkedBody -> ShowS # show :: ChunkedBody -> String # showList :: [ChunkedBody] -> ShowS #
ToBody ChunkedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: ChunkedBody -> RqBody Source #

chunkedLength :: Lens' ChunkedBody Integer Source #

fuseChunks :: ChunkedBody -> ConduitM ByteString ByteString (ResourceT IO) () -> ChunkedBody Source #

fullChunks :: ChunkedBody -> Integer Source #

remainderBytes :: ChunkedBody -> Maybe Integer Source #

data HashedBody Source #

An opaque request body containing a SHA256 hash.

Constructors

HashedStream (Digest SHA256) !Integer (ConduitM () ByteString (ResourceT IO) ())
HashedBytes (Digest SHA256) ByteString

Instances

Show HashedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods showsPrec :: Int -> HashedBody -> ShowS # show :: HashedBody -> String # showList :: [HashedBody] -> ShowS #
IsString HashedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods fromString :: String -> HashedBody #
ToBody HashedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: HashedBody -> RqBody Source #
ToHashedBody HashedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: HashedBody -> HashedBody Source #

sha256Base16 :: HashedBody -> ByteString Source #

data RqBody Source #

Invariant: only services that support _both_ standard and chunked signing expose RqBody as a parameter.

Constructors

Chunked ChunkedBody
Hashed HashedBody

Instances

Show RqBody Source #
Instance details Defined in Network.AWS.Data.Body Methods showsPrec :: Int -> RqBody -> ShowS # show :: RqBody -> String # showList :: [RqBody] -> ShowS #
IsString RqBody Source #
Instance details Defined in Network.AWS.Data.Body Methods fromString :: String -> RqBody #
ToBody RqBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: RqBody -> RqBody Source #

md5Base64 :: RqBody -> Maybe ByteString Source #

isStreaming :: RqBody -> Bool Source #

toRequestBody :: RqBody -> RequestBody Source #

contentLength :: RqBody -> Integer Source #

class ToHashedBody a where Source #

Anything that can be safely converted to a HashedBody.

Methods

toHashed :: a -> HashedBody Source #

Convert a value to a hashed request body.

Instances

ToHashedBody ByteString Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: ByteString -> HashedBody Source #
ToHashedBody ByteString Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: ByteString -> HashedBody Source #
ToHashedBody Text Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: Text -> HashedBody Source #
ToHashedBody Value Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: Value -> HashedBody Source #
ToHashedBody String Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: String -> HashedBody Source #
ToHashedBody Text Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: Text -> HashedBody Source #
ToHashedBody Element Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: Element -> HashedBody Source #
ToHashedBody QueryString Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: QueryString -> HashedBody Source #
ToHashedBody HashedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: HashedBody -> HashedBody Source #
ToHashedBody Base64 Source #
Instance details Defined in Network.AWS.Data.Base64 Methods toHashed :: Base64 -> HashedBody Source #
ToHashedBody (HashMap Text Value) Source #
Instance details Defined in Network.AWS.Data.Body Methods toHashed :: HashMap Text Value -> HashedBody Source #

class ToBody a where Source #

Anything that can be converted to a streaming request Body.

Minimal complete definition

Nothing

Methods

toBody :: a -> RqBody Source #

Convert a value to a request body.

toBody :: ToHashedBody a => a -> RqBody Source #

Convert a value to a request body.

Instances

ToBody ByteString Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: ByteString -> RqBody Source #
ToBody ByteString Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: ByteString -> RqBody Source #
ToBody Text Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: Text -> RqBody Source #
ToBody Value Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: Value -> RqBody Source #
ToBody String Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: String -> RqBody Source #
ToBody Text Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: Text -> RqBody Source #
ToBody Element Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: Element -> RqBody Source #
ToBody QueryString Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: QueryString -> RqBody Source #
ToBody RqBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: RqBody -> RqBody Source #
ToBody HashedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: HashedBody -> RqBody Source #
ToBody ChunkedBody Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: ChunkedBody -> RqBody Source #
ToBody Base64 Source #
Instance details Defined in Network.AWS.Data.Base64 Methods toBody :: Base64 -> RqBody Source #
ToHashedBody a => ToBody (Maybe a) Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: Maybe a -> RqBody Source #
ToBody (HashMap Text Value) Source #
Instance details Defined in Network.AWS.Data.Body Methods toBody :: HashMap Text Value -> RqBody Source #

_Body :: ToBody a => AReview RqBody a Source #