Structureswift-nio 2.72.0NIOCore
FileRegion
A FileRegion represent a readable portion usually created to be sent over the network.
struct FileRegionUsually a FileRegion will allow the underlying transport to use sendfile to transfer its content and so allows transferring the file content without copying it into user-space at all. If the actual transport implementation really can make use of sendfile or if it will need to copy the content to user-space first and use write / writev is an implementation detail. That said using FileRegion is the recommended way to transfer file content if possible.
One important note, depending your ChannelPipeline setup it may not be possible to use a FileRegion as a ChannelHandler may need access to the bytes (in a ByteBuffer) to transform these.
See also
struct ByteBufferByteBufferstores contiguously allocated raw bytes. It is a random and sequential accessible sequence of zero or more bytes (octets).struct ByteBufferViewA view into a portion of a
ByteBuffer.struct ByteBufferAllocatorThe preferred allocator for
ByteBuffervalues. The allocation strategy is opaque but is currently libc’smalloc,reallocandfree.enum EndiannessEndianness refers to the sequential order in which bytes are arranged into larger numerical values when stored in memory or when transmitted over digital links.
class NIOFileHandleA
NIOFileHandleis a handle to an open file.protocol FileDescriptortypealias NIOPOSIXFileModeenum IODataIODataunifies standard SwiftNIO types that are raw bytes of data; currentlyByteBufferandFileRegion.
Citizens in NIOCore
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
Type members
init(fileHandle: NIOFileHandle) throws Create a new
FileRegionforming a complete file.init(fileHandle: NIOFileHandle, readerIndex: Int, endIndex: Int) Create a new
FileRegionfrom an openNIOFileHandle.static func == (lhs: FileRegion, rhs: FileRegion) -> Bool
Instance members
var description: Stringvar endIndex: IntThe end index of this
FileRegion.let fileHandle: NIOFileHandleThe
NIOFileHandlethat is used by thisFileRegion.var readableBytes: IntThe number of readable bytes within this FileRegion (taking the
readerIndexandendIndexinto account).var readerIndex: IntThe current reader index of this
FileRegionfunc moveReaderIndex(forwardBy: Int) Move the readerIndex forward by
offset.
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.