mirror of
https://github.com/apple/swift-nio
synced 2026-11-22 04:30:41 +00:00
Motivation: As requested in issues [#2875](https://github.com/apple/swift-nio/issues/2875) and [#2876](https://github.com/apple/swift-nio/issues/2876), it would be convenient to be able to read the contents of a file into more data types such as `Array`, `ArraySlice` & Foundation's `Data`. Modifications: - Extend `Array`, `ArraySlice` & `Data` to be initialisable with the contents of a file. Result: The contents of a file can be read into more data types. --------- Co-authored-by: George Barnett <gbarnett@apple.com>
55 lines
1.9 KiB
Swift
55 lines
1.9 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the SwiftNIO open source project
|
|
//
|
|
// Copyright (c) 2024 Apple Inc. and the SwiftNIO project authors
|
|
// Licensed under Apache License v2.0
|
|
//
|
|
// See LICENSE.txt for license information
|
|
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#if os(macOS) || os(iOS) || os(tvOS) || os(watchOS) || os(Linux) || os(Android)
|
|
import NIOCore
|
|
|
|
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
|
|
extension Array where Element == UInt8 {
|
|
/// Reads the contents of the file at the path.
|
|
///
|
|
/// - Parameters:
|
|
/// - path: The path of the file to read.
|
|
/// - maximumSizeAllowed: The maximum size of file which can be read, in bytes, as a ``ByteCount``.
|
|
/// - fileSystem: The ``FileSystemProtocol`` instance to use to read the file.
|
|
public init(
|
|
contentsOf path: FilePath,
|
|
maximumSizeAllowed: ByteCount,
|
|
fileSystem: some FileSystemProtocol
|
|
) async throws {
|
|
let byteBuffer = try await fileSystem.withFileHandle(forReadingAt: path) { handle in
|
|
try await handle.readToEnd(maximumSizeAllowed: maximumSizeAllowed)
|
|
}
|
|
|
|
self = Self(buffer: byteBuffer)
|
|
}
|
|
|
|
/// Reads the contents of the file at the path using ``FileSystem``.
|
|
///
|
|
/// - Parameters:
|
|
/// - path: The path of the file to read.
|
|
/// - maximumSizeAllowed: The maximum size of file which can be read, as a ``ByteCount``.
|
|
public init(
|
|
contentsOf path: FilePath,
|
|
maximumSizeAllowed: ByteCount
|
|
) async throws {
|
|
self = try await Self(
|
|
contentsOf: path,
|
|
maximumSizeAllowed: maximumSizeAllowed,
|
|
fileSystem: .shared
|
|
)
|
|
}
|
|
}
|
|
#endif
|