File: JSONEncoder.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (63 lines) | stat: -rw-r--r-- 2,229 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

public import struct Foundation.Data
public import class Foundation.JSONDecoder
public import class Foundation.JSONEncoder

/// Returns the raw bytes of the given object's json representation.
public func jsonDataArray<T: Encodable>(from object: T) throws -> [UInt8] {
    Array(try JSONEncoder().encode(object))
}

extension JSONEncoder {
    public convenience init(outputFormatting: JSONEncoder.OutputFormatting = []) {
        self.init()
        self.outputFormatting = outputFormatting
    }
}

extension JSONDecoder {
    public func decode<T>(_ type: T.Type, from path: Path, fs: any FSProxy) throws -> T where T : Decodable {
        let data = try fs.read(path)
        do {
            return try decode(type, from: Data(data))
        } catch {
            throw JSONFileParsingError(path: path, data: data, type: type)
        }
    }
}

public struct JSONFileParsingError<T>: Error, CustomStringConvertible, Sendable {
    public let path: Path
    public let data: ByteString
    public let type: T.Type

    public var description: String {
        "Failed to decode contents of file '\(path.str)' as \(type): \(data.unsafeStringValue)"
    }
}

public struct CommandLineOutputJSONParsingError: Error, CustomStringConvertible, Sendable {
    public let commandLine: [String]
    public let data: Data

    public init(commandLine: [String], data: Data) {
        self.commandLine = commandLine
        self.data = data
    }

    public var description: String {
        let codec = UNIXShellCommandCodec(encodingStrategy: .singleQuotes, encodingBehavior: .fullCommandLine)
        return "Could not parse output of `\(codec.encode(commandLine))` as JSON: \(String(decoding: data, as: UTF8.self))"
    }
}