File: SampleDownloadSection.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 (62 lines) | stat: -rw-r--r-- 2,301 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
/*
 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
*/

import Foundation

/// A section that contains download data for a sample project.
///
/// The `action` property is the reference to the file for download, e.g., `sample.zip`.
public struct SampleDownloadSection: RenderSection, Equatable {
    public var kind: RenderSectionKind = .sampleDownload
    /// The call to action in the section.
    public var action: RenderInlineContent

    /// Creates a new sample project download section.
    /// - Parameter action: The call to action in the section.
    public init(action: RenderInlineContent) {
        self.action = action
    }
    
    // MARK: - Codable
    
    /// The list of keys you use to encode or decode this section.
    public enum CodingKeys: String, CodingKey {
        case kind, action
    }
    
    public init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        action = try container.decode(RenderInlineContent.self, forKey: .action)
    }
    
    public func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(kind, forKey: .kind)
        try container.encode(action, forKey: .action)
    }
}

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

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

        return diffBuilder.differences
    }

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