Files
amiibo-service/Sources/AmiiboService/Internal/Protocols/KeyNameModel.swift
T

33 lines
1.0 KiB
Swift
Raw Normal View History

2025-10-07 22:32:54 +00:00
// ===----------------------------------------------------------------------===
//
// This source file is part of the Amiibo Service open source project
//
2026-03-22 23:39:48 +00:00
// Copyright (c) 2026 Röck+Cöde VoF. and the Amiibo Service project authors
2025-10-07 22:32:54 +00:00
// Licensed under Apache license v2.0
//
// See LICENSE for license information
2025-10-07 22:32:54 +00:00
// See CONTRIBUTORS for the list of Amiibo Service project authors
//
2025-10-07 22:32:54 +00:00
// SPDX-License-Identifier: Apache-2.0
//
// ===----------------------------------------------------------------------===
2026-03-22 23:39:48 +00:00
/// A protocol that defines models containing a `key` and `name` pair.
protocol KeyNameModel: Sendable, Hashable {
// MARK: Properties
2026-03-22 23:39:48 +00:00
/// A hexadecimal key that uniquely identifies this model.
var key: String { get }
2025-09-09 17:30:19 +00:00
2026-03-22 23:39:48 +00:00
/// A display name for this model.
var name: String { get }
2025-09-09 17:30:19 +00:00
// MARK: Initializers
2025-09-09 17:30:19 +00:00
/// Initializes this model from a given payload.
/// - Parameter payload: A payload that contains the values for the model.
init(_ payload: Components.Schemas.Tuple)
}