Generic Structure

CodableConfiguration

A property wrapper that makes a type codable, by supplying a configuration that provides additional information for serialization.

Declaration 宣言

@propertyWrapper struct CodableConfiguration<T, ConfigurationProvider> where T : DecodableWithConfiguration, T : EncodableWithConfiguration, ConfigurationProvider : DecodingConfigurationProviding, ConfigurationProvider : EncodingConfigurationProviding, T.DecodingConfiguration == ConfigurationProvider.DecodingConfiguration, T.EncodingConfiguration == ConfigurationProvider.EncodingConfiguration

Overview 概要

CodableConfiguration allows you to create Codable types whose members don’t all conform to Codable. For types that can’t support encoding and decoding by themselves but could become encodable and decodable with some statically-defined information, use the @CodableConfiguration wrapper. This lets you assign a configuration provider — a type that conforms to both EncodingConfigurationProviding and DecodingConfigurationProviding — to supply this data.

Limiting the CodableConfiguration to statically-defined information protects clients from loading unexpected data, similar to the protection provided by NSSecureCoding.

In the following example, the Message type uses @CodableConfiguration for an AttributedString property called content. While AttributedString does conform to Codable, it can only encode its known attributes — those declared by the platform SDK — as part of this conformance. By adding a CodableConfiguration for the custom MyAttributes type, Message uses encode(to:configuration:) when encoding content, which preserves the custom attributes.

struct Message: Codable {
    let date: Date
    let sender: Person
    @CodableConfiguration(from: MyAttributes.self) var content = AttributedString()
}

Topics 話題

Creating a Codable Configuration コード化可能構成設定を作成する

init(wrappedValue: T)

Creates a codable configuration wrapper for the given value.

init(wrappedValue: T, from: ConfigurationProvider.Type)

Creates a codable configuration wrapper for the given value, using the given configuration provider type.

init(wrappedValue: T, from: KeyPath<AttributeScopes, ConfigurationProvider.Type>)

Creates a codable configuration wrapper for the given value, using given configuration provider type identified by key path.

Available when ConfigurationProvider conforms to AttributeScope. ConfigurationProviderがAttributeScopeに準拠する場合に利用可能です。

Accessing the Wrapped Value ラップされた値にアクセスする

var wrappedValue: T

The underlying value to make codable, using data from the configuration provider.

Encoding and Decoding エンコーディングとデコーディング

init(from: Decoder)

Creates a new instance by decoding from the given decoder. 新しいインスタンスをこの与えられたデコーダからデコーディングすることによって作成します。

func encode(to: Encoder)

Encodes the value into the given encoder. 値をこの与えられたエンコーダへとエンコードします。

Supporting Hashing ハッシュ化をサポートする

var hashValue: Int

The hash value. ハッシュ値。

Available when T conforms to Hashable. TがHashableに準拠する時に利用可能です。

func hash(into: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher. この値の本質的な構成要素それらを、それらをこの与えられたハーシャーに供給する事によってハッシュ化します。

Available when T conforms to Hashable. TがHashableに準拠する時に利用可能です。

Comparing Configuration Instances 構成設定インスタンスを比較する

static func == (CodableConfiguration<T, ConfigurationProvider>, CodableConfiguration<T, ConfigurationProvider>) -> Bool

Returns a Boolean value that indicates whether two codable configurations are equal.

Available when T conforms to Equatable. TがEquatableに準拠する時に利用可能です。

static func != (CodableConfiguration<T, ConfigurationProvider>, CodableConfiguration<T, ConfigurationProvider>) -> Bool

Returns a Boolean value that indicates whether two codable configurations are unequal.