mirror of
https://github.com/apple/swift-nio.git
synced 2026-05-20 20:30:36 +00:00
Karan Lokchandani
4a9a971110
### Motivation: The documentation for String(buffer:) initializer does not clearly indicate that this operation will always succeed, which may leave developers uncertain about error handling requirements. fixes: https://github.com/apple/swift-nio/issues/3449 ### Modifications: Updated the documentation for String(buffer:) to explicitly mention that the initialization will always succeed. ### Result: Developers will have clearer understanding that String(buffer:) is a safe operation that does not require error handling. Signed-off-by: Karan <karanlokchandani@protonmail.com>
73 lines
2.5 KiB
Swift
73 lines
2.5 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the SwiftNIO open source project
|
|
//
|
|
// Copyright (c) 2020 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 canImport(Dispatch)
|
|
import Dispatch
|
|
#endif
|
|
|
|
extension Array where Element == UInt8 {
|
|
|
|
/// Creates a `[UInt8]` from the given buffer. The entire readable portion of the buffer will be read.
|
|
/// - Parameter buffer: The buffer to read.
|
|
@inlinable
|
|
public init(buffer: ByteBuffer) {
|
|
var buffer = buffer
|
|
self = buffer.readBytes(length: buffer.readableBytes)!
|
|
}
|
|
|
|
}
|
|
|
|
extension String {
|
|
|
|
/// Creates a `String` from a given `ByteBuffer`. The entire readable portion of the buffer will be read.
|
|
///
|
|
/// This initializer always succeeds. If the buffer contains bytes that are not valid UTF-8, they will be
|
|
/// replaced with the Unicode replacement character (U+FFFD).
|
|
///
|
|
/// If you need to validate that the buffer contains valid UTF-8, use ``ByteBuffer/readUTF8ValidatedString(length:)``
|
|
/// instead, which throws an error for invalid UTF-8.
|
|
///
|
|
/// - Parameter buffer: The buffer to read.
|
|
@inlinable
|
|
public init(buffer: ByteBuffer) {
|
|
var buffer = buffer
|
|
self = buffer.readString(length: buffer.readableBytes)!
|
|
}
|
|
|
|
/// Creates a `String` from a given `Int` with a given base (`radix`), padded with zeroes to the provided `padding` size.
|
|
///
|
|
/// - Parameters:
|
|
/// - radix: radix base to use for conversion.
|
|
/// - padding: the desired length of the resulting string.
|
|
@inlinable
|
|
internal init<Value>(_ value: Value, radix: Int, padding: Int) where Value: BinaryInteger {
|
|
let formatted = String(value, radix: radix)
|
|
self = String(repeating: "0", count: padding - formatted.count) + formatted
|
|
}
|
|
}
|
|
|
|
#if canImport(Dispatch)
|
|
extension DispatchData {
|
|
|
|
/// Creates a `DispatchData` from a given `ByteBuffer`. The entire readable portion of the buffer will be read.
|
|
/// - Parameter buffer: The buffer to read.
|
|
@inlinable
|
|
public init(buffer: ByteBuffer) {
|
|
var buffer = buffer
|
|
self = buffer.readDispatchData(length: buffer.readableBytes)!
|
|
}
|
|
|
|
}
|
|
#endif
|