Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention file length in bytes in readFileSize explicitly #2572

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Mention file length in bytes in readFileSize explicitly #2572

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Sources/NIOPosix/NonBlockingFileIO.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,12 +376,12 @@ public struct NonBlockingFileIO: Sendable {
}
}

/// Returns the length of the file associated with `fileHandle`.
/// Returns the length of the file in bytes associated with `fileHandle`.
///
/// - parameters:
/// - fileHandle: The `NIOFileHandle` to read from.
/// - eventLoop: The `EventLoop` to create the returned `EventLoopFuture` from.
/// - returns: An `EventLoopFuture` which is fulfilled if the write was successful or fails on error.
/// - returns: An `EventLoopFuture` which is fulfilled with the length of the file in bytes if the write was successful or fails on error.
public func readFileSize(fileHandle: NIOFileHandle,
eventLoop: EventLoop) -> EventLoopFuture<Int64> {
return self.threadPool.runIfActive(eventLoop: eventLoop) {
Expand Down