Dateien#

Vapor bietet eine einfache API zum asynchronen Lesen und Schreiben von Dateien innerhalb von Route-Handlern. Diese API baut auf NIOs NonBlockingFileIO-Typ auf.

Lesen#

Die Hauptmethode zum Lesen einer Datei liefert Chunks an einen Callback-Handler, sobald diese von der Festplatte gelesen werden. Die zu lesende Datei wird durch ihren Pfad angegeben. Bei relativen Pfaden wird im aktuellen Arbeitsverzeichnis des Prozesses gesucht.

// Asynchronously reads a file from disk.
let readComplete: EventLoopFuture<Void> = req.fileio.readFile(at: "/path/to/file") { chunk in
    print(chunk) // ByteBuffer
}

// Or

try await req.fileio.readFile(at: "/path/to/file") { chunk in
    print(chunk) // ByteBuffer
}
// Read is complete

Wenn EventLoopFutures verwendet werden, signalisiert das zurückgegebene Future, wann das Lesen abgeschlossen wurde oder ein Fehler aufgetreten ist. Wenn async/await verwendet wird, ist das Lesen abgeschlossen, sobald await zurückgekehrt ist. Ist ein Fehler aufgetreten, wird dieser geworfen.

Stream#

Die Methode streamFile konvertiert eine Datei, die gestreamt wird, in eine Response. Diese Methode setzt automatisch passende Header wie ETag und Content-Type.

// Asynchronously streams file as HTTP response.
req.fileio.streamFile(at: "/path/to/file").map { res in
    print(res) // Response
}

// Or

let res = req.fileio.streamFile(at: "/path/to/file")
print(res)

Das Ergebnis kann direkt von deinem Route-Handler zurückgegeben werden.

Collect#

Die Methode collectFile liest die angegebene Datei in einen Buffer ein.

// Reads the file into a buffer.
req.fileio.collectFile(at: "/path/to/file").map { buffer in 
    print(buffer) // ByteBuffer
}

// or

let buffer = req.fileio.collectFile(at: "/path/to/file")
print(buffer)

Schreiben#

Die Methode writeFile unterstützt das Schreiben eines Buffers in eine Datei.

// Writes buffer to file.
req.fileio.writeFile(ByteBuffer(string: "Hello, world"), at: "/path/to/file")

Das zurückgegebene Future signalisiert, wann das Schreiben abgeschlossen wurde oder ein Fehler aufgetreten ist.

Middleware#

Weitere Informationen zum automatischen Ausliefern von Dateien aus dem Public-Ordner deines Projekts findest du unter Middleware → FileMiddleware.

Fortgeschritten#

Für Fälle, die von Vapors API nicht unterstützt werden, kannst du NIOs NonBlockingFileIO-Typ direkt verwenden.

// Main thread.
let fileHandle = try await app.fileio.openFile(
    path: "/path/to/file", 
    eventLoop: app.eventLoopGroup.next()
).get()
print(fileHandle)

// In a route handler.
let fileHandle = try await req.application.fileio.openFile(
    path: "/path/to/file", 
    eventLoop: req.eventLoop)
print(fileHandle)

Weitere Informationen findest du in SwiftNIOs API-Referenz.