Body.Basic

This module defines the Body typeclass for HTTP body streams, and shared conversion types ToByteArray and FromByteArray used for encoding and decoding body content.

class Std.Http.Body (α : Type) : Type

Typeclass for values that can be read as HTTP body streams.

• recv : α → Internal.IO.Async.Async (Option Chunk)

  Receives the next body chunk. Returns none at end-of-stream.

• close : α → Internal.IO.Async.Async Unit

  Closes the body stream.

• isClosed : α → Internal.IO.Async.Async Bool

  Returns true when the body stream is closed.

• recvSelector : α → Internal.IO.Async.Selector (Option Chunk)

  Selector that resolves when a chunk is available or EOF is reached.

• getKnownSize : α → Internal.IO.Async.Async (Option Length)

  Gets the declared size of the body.

• setKnownSize : α → Option Length → Internal.IO.Async.Async Unit

  Sets the declared size of a body.

class Std.Http.Body.ToByteArray (α : Type) : Type

Typeclass for types that can be converted to a ByteArray.

• toByteArray : α → ByteArray

  Transforms into a ByteArray.

@[implicit_reducible]

instance Std.Http.Body.instToByteArrayByteArray : ToByteArray ByteArray

Equations

• Std.Http.Body.instToByteArrayByteArray = { toByteArray := id }

@[implicit_reducible]

instance Std.Http.Body.instToByteArrayString : ToByteArray String

Equations

• Std.Http.Body.instToByteArrayString = { toByteArray := String.toUTF8 }

class Std.Http.Body.FromByteArray (α : Type) : Type

Typeclass for types that can be decoded from a ByteArray. The conversion may fail with an error message if the bytes are not valid for the target type.

• fromByteArray : ByteArray → Except String α

  Attempts to decode a ByteArray into the target type, returning an error message on failure.

@[implicit_reducible]

instance Std.Http.Body.instFromByteArrayByteArray : FromByteArray ByteArray

Equations

• Std.Http.Body.instFromByteArrayByteArray = { fromByteArray := Except.ok }

@[implicit_reducible]

instance Std.Http.Body.instFromByteArrayString : FromByteArray String

Equations

• One or more equations did not get rendered due to their size.