File: ParameterRenderSection.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • 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 (65 lines) | stat: -rw-r--r-- 2,632 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
64
65
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021 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
*/

/// A section that contains a list of parameters.
public struct ParametersRenderSection: RenderSection, Equatable {
    public var kind: RenderSectionKind = .parameters
    /// The list of parameter sub-sections.
    public let parameters: [ParameterRenderSection]
    
    /// Creates a new parameters section with the given list.
    public init(parameters: [ParameterRenderSection]) {
        self.parameters = parameters
    }
}

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

        diffBuilder.addDifferences(atKeyPath: \.kind, forKey: CodingKeys.kind)
        diffBuilder.addDifferences(atKeyPath: \.parameters, forKey: CodingKeys.parameters)

        return diffBuilder.differences
    }

    /// Returns if this ParametersRenderSection is similar enough to the given one.
    func isSimilar(to other: ParametersRenderSection) -> Bool {
        return self.parameters == other.parameters
    }
}

/// A section that contains a single, named parameter.
public struct ParameterRenderSection: Codable, Equatable {
    /// The parameter name.
    public let name: String
    /// Free-form content to provide information about the parameter.
    public var content: [RenderBlockContent]
}

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

        diffBuilder.addDifferences(atKeyPath: \.name, forKey: CodingKeys.name)
        diffBuilder.addDifferences(atKeyPath: \.content, forKey: CodingKeys.content)

        return diffBuilder.differences
    }

    /// Returns if this ParameterRenderSection is similar enough to the given one.
    func isSimilar(to other: ParameterRenderSection) -> Bool {
        return self.name == other.name || self.content == other.content
    }
}