Response.Body

Topics

Initializers

• init(asyncStream: (any AsyncBodyStreamWriter) async throws -> (), byteBufferAllocator: ByteBufferAllocator)
  Creates a chunked HTTP Response steam using AsyncBodyStreamWriter.
• init(asyncStream: (any AsyncBodyStreamWriter) async throws -> (), count: Int, byteBufferAllocator: ByteBufferAllocator)
  Creates a chunked HTTP Response steam using AsyncBodyStreamWriter.
• init(buffer: ByteBuffer, byteBufferAllocator: ByteBufferAllocator)
  Create a new body from a Swift NIO ByteBuffer.
• init(byteBufferAllocator: ByteBufferAllocator)
  Creates an empty body. Useful for GET requests where HTTP bodies are forbidden.
• init(data: Data, byteBufferAllocator: ByteBufferAllocator)
  Create a new body wrapping Data.
• init(dispatchData: DispatchData, byteBufferAllocator: ByteBufferAllocator)
  Create a new body wrapping DispatchData.
• init(managedAsyncStream: (any AsyncBodyStreamWriter) async throws -> (), byteBufferAllocator: ByteBufferAllocator)
  Creates a managed chunked HTTP Response steam using AsyncBodyStreamWriter that automtically closes or fails based if the closure throws an error or returns.
• init(managedAsyncStream: (any AsyncBodyStreamWriter) async throws -> (), count: Int, byteBufferAllocator: ByteBufferAllocator)
  Creates a managed chunked HTTP Response steam using AsyncBodyStreamWriter that automtically closes or fails based if the closure throws an error or returns.
• init(staticString: StaticString, byteBufferAllocator: ByteBufferAllocator)
  Create a new body from the UTF8 representation of a StaticString.
• init(stream: (any BodyStreamWriter) -> (), byteBufferAllocator: ByteBufferAllocator)
• init(stream: (any BodyStreamWriter) -> (), count: Int, byteBufferAllocator: ByteBufferAllocator)
• init(string: String, byteBufferAllocator: ByteBufferAllocator)
  Create a new body from the UTF8 representation of a String.
• init(stringLiteral: String)
  ExpressibleByStringLiteral conformance.

Instance Properties

• var buffer: ByteBuffer?
• var count: Int
  The size of the HTTP body’s data. -1 is a chunked stream.
• var data: Data?
  Returns static data if not streaming.
• var description: String
  See CustomDebugStringConvertible.
• var string: String?

Instance Methods

• func collect(on: any EventLoop) -> EventLoopFuture<ByteBuffer?>

Type Properties

• static let empty: Response.Body
  An empty Response.Body.