Reads the contents of a file at the supplied path.
This declaration is deprecated: Migrate to async API
func collectFile(at path: String) -> EventLoopFuture<ByteBuffer> s5Vapor6FileIOV07collectB02at7NIOCore15EventLoopFutureCyAF10ByteBufferVGSS_tF What are these?3FDRPPath to file on the disk.
Future containing the file data as a ByteBuffer.
let data = try req.fileio.collectFile(at: "/path/to/file.txt").wait()
print(data) // file dataimport VaporVapor is a framework for building server applications, APIs and websites in Swift. It provides a safe, performant and scalable foundation for building large complex backends.
struct FileIOFileIO is a convenience wrapper around SwiftNIO’s NonBlockingFileIO.
@frozen struct StringA Unicode string value that is a collection of characters.
final class EventLoopFuture<Value>Holder for a result that will be provided later.
struct ByteBufferByteBuffer stores contiguously allocated raw bytes. It is a random and sequential accessible sequence of zero or more bytes (octets).
func asyncStreamFile(at path: String, chunkSize: Int = NonBlockingFileIO.defaultChunkSize, mediaType: HTTPMediaType? = nil, advancedETagComparison: Bool = false, onCompleted: @escaping (Result<Void, Error>) async throws -> () = { _ in }) async throws -> Response Generates a chunked Response for the specified file. This method respects values in the "ETag" header and is capable of responding 304 Not Modified if the file in question has not been modified since last served. If advancedETagComparison is set to true, the response will have its ETag field set to a byte-by-byte hash of the requested file. If set to false, a simple ETag consisting of the last modified date and file size will be used. This method will also set the "Content-Type" header automatically if an appropriate MediaType can be found for the file’s suffix.
func collectFile(at path: String) async throws -> ByteBuffer Reads the contents of a file at the supplied path.
func readFile(at path: String, chunkSize: Int = NonBlockingFileIO.defaultChunkSize, offset: Int64? = nil, byteCount: Int? = nil) async throws -> FileChunks Reads the contents of a file at the supplied path in chunks.
func streamFile(at path: String, chunkSize: Int = NonBlockingFileIO.defaultChunkSize, mediaType: HTTPMediaType? = nil, advancedETagComparison: Bool, onCompleted: @escaping (Result<Void, Error>) -> () = { _ in }) -> EventLoopFuture<Response> Generates a chunked Response for the specified file. This method respects values in the "ETag" header and is capable of responding 304 Not Modified if the file in question has not been modified since last served. If advancedETagComparison is set to true, the response will have its ETag field set to a byte-by-byte hash of the requested file. If set to false, a simple ETag consisting of the last modified date and file size will be used. This method will also set the "Content-Type" header automatically if an appropriate MediaType can be found for the file’s suffix.
func writeFile(_ buffer: ByteBuffer, at path: String) async throws Write the contents of buffer to a file at the supplied path.
struct FileChunksWrapper around NIOFileSystem.FileChunks. This can be removed once NIOFileSystem reaches a stable API.
@preconcurrency func readFile(at path: String, chunkSize: Int = NonBlockingFileIO.defaultChunkSize, onRead: @escaping (ByteBuffer) -> EventLoopFuture<Void>) -> EventLoopFuture<Void> Reads the contents of a file at the supplied path in chunks.
@preconcurrency func streamFile(at path: String, chunkSize: Int = NonBlockingFileIO.defaultChunkSize, mediaType: HTTPMediaType? = nil, onCompleted: @escaping (Result<Void, Error>) -> () = { _ in }) -> Response Generates a chunked Response for the specified file. This method respects values in the "ETag" header and is capable of responding 304 Not Modified if the file in question has not been modified since last served. This method will also set the "Content-Type" header automatically if an appropriate MediaType can be found for the file’s suffix.
func writeFile(_ buffer: ByteBuffer, at path: String) -> EventLoopFuture<Void> Write the contents of buffer to a file at the supplied path.