Files
swift-nio/Sources/NIOFoundationCompat/JSONSerialization+ByteBuffer.swift
Rick Newton-Rogers adfd61adc5 Use Swift 6.0 docs pipeline (#2966)
### Motivation:

Documentation checking catches more issues in Swift 6.0.

### Modifications:

Adopt the Swift 6.0 image and fix the errors.

### Result:

More accurate docs.
2024-11-07 13:03:47 +00:00

34 lines
1.2 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2021 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
//
//===----------------------------------------------------------------------===//
import Foundation
import NIOCore
extension JSONSerialization {
/// Attempts to derive a Foundation object from a ByteBuffer and return it as `T`.
///
/// - Parameters:
/// - buffer: The ByteBuffer being used to derive the Foundation type.
/// - options: The reading option used when the parser derives the Foundation type from the ByteBuffer.
/// - Returns: The Foundation value if successful or `nil` if there was an issue creating the Foundation type.
@inlinable
public static func jsonObject(
with buffer: ByteBuffer,
options: JSONSerialization.ReadingOptions = []
) throws -> Any {
try JSONSerialization.jsonObject(with: Data(buffer: buffer), options: options)
}
}