Skip to content

MultipartKit

Core

Vapor VaporMacros beta AsyncKit RoutingKit ConsoleKit ConsoleKitCommands ConsoleKitTerminal ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

5.0 (alpha)

4.x 5.0 (alpha) alpha

MultipartKit

Protocols
MultipartPartDecodable
- Initializers
- init(headerFields: HTTPFields, body: RawSpan) throws
MultipartPartEncodable
- Instance Properties
- var headerFields: HTTPFields
- Instance Methods
- func withBody<R>((RawSpan) throws -> R) rethrows -> R
MultipartWriter
Structures
BufferedMultipartWriter
- Initializers
- init(boundary: String, buffer: OutboundBody, bufferCapacity: Int, underlyingWriter: UnderlyingWriter)
- init(boundary: String, bufferCapacity: Int, underlyingWriter: UnderlyingWriter)
- Instance Properties
- let boundary: String
- Instance Methods
- func finish(writingEndBoundary: Bool) async throws(Failure)
- func write(bytes: some Collection<UInt8> & Sendable) async throws(Failure)
- Type Aliases
- BufferedMultipartWriter.Failure
- BufferedMultipartWriter.OutboundBody
ContentDisposition
FormDataDecoder
- Initializers
- init(nestingDepth: Int)
- Instance Properties
- var userInfo: [CodingUserInfoKey : any Sendable]
- Instance Methods
- func decode(_:from:boundary:)
FormDataEncoder
- Initializers
- init()
- Instance Properties
- var userInfo: [CodingUserInfoKey : any Sendable]
- Instance Methods
- func encode<E>(E, boundary: String) throws -> String
- func encode<E, Body>(E, boundary: String, into: inout Body) throws
- func encode<E, Body>(E, boundary: String, to: Body.Type) throws -> Body
MemoryMultipartWriter
- Initializers
- init(boundary: String)
- init(boundary: String, buffer: inout OutboundBody)
- Instance Properties
- let boundary: String
- Instance Methods
- func finish()
- func getResult() -> OutboundBody
- func write(bytes: some Collection<UInt8> & Sendable)
- func writePart(MultipartPart<some MultipartPartBodyElement>)
- Type Aliases
- MemoryMultipartWriter.Failure
MultipartParser
- Initializers
- init(boundary: String)
- Instance Methods
- func parse(Body) throws(MultipartParserError) -> [MultipartPart<Body>]
MultipartParserAsyncSequence
MultipartParserError
MultipartPart
- Initializers
- init(headerFields: HTTPFields, body: Body)
- Instance Properties
- var body: Body
- var contentDisposition: ContentDisposition?
- var headerFields: HTTPFields
StreamingMultipartParserAsyncSequence
StreamingMultipartWriterAsyncSequence
Functions
func makeBoundaryBytes<OutboundBody>(String, end: Bool, as: OutboundBody.Type) -> OutboundBody
Type Aliases
MultipartPartBodyElement
MultipartPartConvertible
Enumerations
MultipartSection
- Enumeration Cases
- case bodyChunk(Body)
- case boundary(end: Bool)
- case headerFields(HTTPFields)
StreamingMultipartPartError
- Enumeration Cases
- case nextPartRequestedWhileStreamingPreviousBody
- case unexpectedSectionWhileStreamingBody

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

You're viewing documentation for a pre-release version. View the latest stable version

Instance Method

withBody(_:)

func withBody<R>(_ closure: (RawSpan) throws -> R) rethrows -> R

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

API Documentation © 2026 Vapor.

Twitter
Mastodon
Bsky
GitHub