Structure

Response.Body

Represents a Response’s body.

struct Body

Overview

let body = Response.Body(string: "Hello, world!")

This can contain any data (streaming or static) and should match the message’s "Content-Type" header.

struct AlreadyConsumedError
Thrown when a streaming body is read a second time after being streamed away.
struct NegativeCountError
Thrown when a streaming body is created with a negative length.

init()
Creates an empty body. Useful for GET requests where HTTP bodies are forbidden.
init(data: Data)
Create a new body wrapping Data.
init(staticString: StaticString)
Create a new body from the UTF8 representation of a StaticString.
init(stream: @Sendable (borrowing any HTTPBodyWriter & ~Escapable) async throws -> Void)
Creates a chunked, streaming HTTP Response body of unknown length.
init(stream: @Sendable (borrowing any HTTPBodyWriter & ~Escapable) async throws -> Void, count: Int?) throws
Creates a chunked, streaming HTTP Response body.
init(string: String)
Create a new body from the UTF8 representation of a String.
init(stringLiteral: String)
ExpressibleByStringLiteral conformance.

var count: Int?
The size of the HTTP body’s data, or nil if it is not known.
var data: Data?
The body’s bytes, or nil if it is empty or is a stream nothing has collected.
var description: String
var string: String?
The body decoded as UTF-8, or nil if it is empty or is a stream nothing has collected.

func collect(max: BodySizeLimit) async throws -> Data?
Reads the whole body into memory, running a streaming body to completion.
func data(max: BodySizeLimit) async throws -> Data?
The body’s bytes, collecting a streaming body first if nothing has collected it yet.
func reduceBytes<R>(into: R, (inout R, Span<UInt8>) async throws -> Void) async throws -> R
Fold the body’s bytes into a value, one chunk at a time.
func string(max: BodySizeLimit) async throws -> String?
The body decoded as UTF-8, collecting a streaming body first if nothing has collected it yet.
func withStreamingBytes((Span<UInt8>) async throws -> Void) async throws
Read the body’s bytes incrementally, without buffering the whole thing.