File: XcodeRequirementReference.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (51 lines) | stat: -rw-r--r-- 2,096 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
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

import Foundation

/// A reference to a version of Xcode that users of your documentation must use.
public struct XcodeRequirementReference: RenderReference, Equatable {
    public var type: RenderReferenceType = .xcodeRequirement
    
    public let identifier: RenderReferenceIdentifier
    
    /// A presentation-friendly title for the version of Xcode required for users of your documentation.
    public let title: String
    
    /// A download URL for the version of Xcode required for users of your documentation.
    public let url: URL
    
    /// Creates a reference to a version of Xcode that users of your documentation must use.
    ///
    /// - Parameters:
    ///   - identifier: An identifier for the requirement's reference
    ///   - title: The Xcode version title.
    ///   - url: A download URL for the Xcode version.
    public init(identifier: RenderReferenceIdentifier, title: String, url: URL) {
        self.identifier = identifier
        self.title = title
        self.url = url
    }
}

// Diffable conformance
extension XcodeRequirementReference: RenderJSONDiffable {
    /// Returns the difference between this XcodeRequirementReference and the given one.
    func difference(from other: XcodeRequirementReference, at path: CodablePath) -> JSONPatchDifferences {
        var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)

        diffBuilder.addDifferences(atKeyPath: \.type, forKey: CodingKeys.type)
        diffBuilder.addDifferences(atKeyPath: \.identifier, forKey: CodingKeys.identifier)
        diffBuilder.addDifferences(atKeyPath: \.title, forKey: CodingKeys.title)
        diffBuilder.addDifferences(atKeyPath: \.url, forKey: CodingKeys.url)

        return diffBuilder.differences
    }
}