1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2018 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
//
//===----------------------------------------------------------------------===//
/// `IOData` unifies standard SwiftNIO types that are raw bytes of data; currently `ByteBuffer` and `FileRegion`.
///
/// Many `ChannelHandler`s receive or emit bytes and in most cases this can be either a `ByteBuffer` or a `FileRegion`
/// from disk. To still form a well-typed `ChannelPipeline` such handlers should receive and emit value of type `IOData`.
public enum IOData {
/// A `ByteBuffer`.
case byteBuffer(ByteBuffer)
/// A `FileRegion`.
///
/// Sending a `FileRegion` through the `ChannelPipeline` using `write` can be useful because some `Channel`s can
/// use `sendfile` to send a `FileRegion` more efficiently.
case fileRegion(FileRegion)
}
/// `IOData` objects are comparable just like the values they wrap.
extension IOData: Equatable {}
@available(*, unavailable)
extension IOData: Sendable {}
/// `IOData` provide a number of readable bytes.
extension IOData {
/// Returns the number of readable bytes in this `IOData`.
public var readableBytes: Int {
switch self {
case .byteBuffer(let buf):
return buf.readableBytes
case .fileRegion(let region):
return region.readableBytes
}
}
/// Move the readerIndex forward by `offset`.
public mutating func moveReaderIndex(forwardBy: Int) {
switch self {
case .byteBuffer(var buffer):
buffer.moveReaderIndex(forwardBy: forwardBy)
self = .byteBuffer(buffer)
case .fileRegion(var fileRegion):
fileRegion.moveReaderIndex(forwardBy: forwardBy)
self = .fileRegion(fileRegion)
}
}
}
extension IOData: CustomStringConvertible {
public var description: String {
switch self {
case .byteBuffer(let byteBuffer):
return "IOData { \(byteBuffer) }"
case .fileRegion(let fileRegion):
return "IOData { \(fileRegion) }"
}
}
}
|
