Apple/swift-nio
1
0
Fork 0
mirror of https://github.com/apple/swift-nio.git synced 2026-05-20 20:30:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
benchmarks_script_missing_diffs
swift-nio/Sources/_NIOFileSystem/Docs.docc/Extensions/FileHandleProtocol.md
T
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

470 B
Raw Permalink Blame History

_NIOFileSystem/FileHandleProtocol

Topics

File Information

  • info()

Permissions

  • replacePermissions(_:)
  • addPermissions(_:)
  • removePermissions(_:)

Extended Attributes

  • attributeNames()
  • valueForAttribute(_:)
  • updateValueForAttribute(_:attribute:)
  • removeValueForAttribute(_:)

Descriptor Management

  • synchronize()
  • withUnsafeDescriptor(_:)
  • detachUnsafeFileDescriptor()
  • close()
Reference in New Issue View Git Blame Copy Permalink