Files
swift-nio/Sources/_NIOFileSystem/Docs.docc/Extensions/ReadableFileHandleProtocol.md
Joseph Heck 6b33489e64 Updates to present docs on _NIOFileSystem (#3477)
This re-enables documentation lost during refactoring work, under the
target _NIOFileSystem

resolves #3474 

### Motivation:

During the refactoring of NIOFileSystem and recent Swift updates, the
mechanism to "shadow" symbols using `@_exported import` has stopped
working for documentation and imports for symbols, which means that
_NIOFileSystem is the target that needs to host the documentation for
this (for now)

### Modifications:

Moves DocC catalog into _NIOFileSystem target, and updates
disambiguation hashes on overloaded symbols in order to verify no
warnings are presented while generating documentation.
Updates .spi.yml to present _NIOFileSystem instead of NIOFileSystem

### Result:

Previous documentation should be available again, although at a slightly
different URI structure within Swift Package Index.

Co-authored-by: Cory Benfield <lukasa@apple.com>
2026-01-13 14:22:46 +00:00

511 B

_NIOFileSystem/ReadableFileHandleProtocol

Topics

Read the contents of a file

  • bufferedReader(startingAtAbsoluteOffset:capacity:)
  • readChunks(chunkLength:)
  • readChunks(in:chunkLength:)
  • readChunks(in:chunkLength:)
  • readChunks(in:chunkLength:)
  • readChunks(in:chunkLength:)
  • readChunks(in:chunkLength:)
  • readChunks(in:chunkLength:)
  • readToEnd(fromAbsoluteOffset:maximumSizeAllowed:)

Read part of a file

  • readChunk(fromAbsoluteOffset:length:)