KeyedEncodingContainerProtocol

protocol KeyedEncodingContainerProtocol

A type that provides a view into an encoder's storage and is used to hold the encoded properties of an encodable type in a keyed manner.

Conforming Types KeyedEncodingContainer
Associated Types
associatedtype Key

Encoders should provide types conforming to KeyedEncodingContainerProtocol for their format.

Instance Variables

var codingPath Required

The path of coding keys taken to get to this point in encoding.

Declaration

var codingPath: [CodingKey]

Instance Methods

func encode(_ value: Bool, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Bool, forKey key: Self.Key) throws
func encode(_ value: String, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: String, forKey key: Self.Key) throws
func encode(_ value: Double, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Double, forKey key: Self.Key) throws
func encode(_ value: Float, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Float, forKey key: Self.Key) throws
func encode(_ value: Int, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Int, forKey key: Self.Key) throws
func encode(_ value: Int8, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Int8, forKey key: Self.Key) throws
func encode(_ value: Int16, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Int16, forKey key: Self.Key) throws
func encode(_ value: Int32, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Int32, forKey key: Self.Key) throws
func encode(_ value: Int64, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: Int64, forKey key: Self.Key) throws
func encode(_ value: UInt, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: UInt, forKey key: Self.Key) throws
func encode(_ value: UInt8, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: UInt8, forKey key: Self.Key) throws
func encode(_ value: UInt16, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: UInt16, forKey key: Self.Key) throws
func encode(_ value: UInt32, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: UInt32, forKey key: Self.Key) throws
func encode(_ value: UInt64, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode(_ value: UInt64, forKey key: Self.Key) throws
func encode(_ value: T, forKey key: Self.Key) throws Required

Encodes the given value for the given key.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encode<T>(_ value: T, forKey key: Self.Key) throws where T: Encodable
func encodeConditional(_ object: T, forKey key: Self.Key) throws Required

Encodes a reference to the given object only if it is encoded unconditionally elsewhere in the payload (previously, or in the future).

For encoders which don't support this feature, the default implementation encodes the given object unconditionally.

  • parameter object: The object to encode.
  • parameter key: The key to associate the object with.

Declaration

mutating func encodeConditional<T>(_ object: T, forKey key: Self.Key) throws where T: AnyObject, T: Encodable
func encodeIfPresent(_ value: Bool?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Bool?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: String?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: String?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Double?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Double?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Float?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Float?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Int?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Int?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Int8?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Int8?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Int16?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Int16?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Int32?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Int32?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: Int64?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: Int64?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: UInt?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: UInt?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: UInt8?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: UInt8?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: UInt16?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: UInt16?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: UInt32?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: UInt32?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: UInt64?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent(_ value: UInt64?, forKey key: Self.Key) throws
func encodeIfPresent(_ value: T?, forKey key: Self.Key) throws Required

Encodes the given value for the given key if it is not nil.

  • parameter value: The value to encode.
  • parameter key: The key to associate the value with.

Declaration

mutating func encodeIfPresent<T>(_ value: T?, forKey key: Self.Key) throws where T: Encodable
func encodeNil(forKey key: Self.Key) throws Required

Encodes a null value for the given key.

  • parameter key: The key to associate the value with.

Declaration

mutating func encodeNil(forKey key: Self.Key) throws
func nestedContainer(keyedBy keyType: NestedKey.Type, forKey key: Self.Key) -> KeyedEncodingContainer<NestedKey> Required

Stores a keyed encoding container for the given key and returns it.

  • parameter keyType: The key type to use for the container.
  • parameter key: The key to encode the container for.

Declaration

mutating func nestedContainer<NestedKey>(keyedBy keyType: NestedKey.Type, forKey key: Self.Key) -> KeyedEncodingContainer<NestedKey> where NestedKey: CodingKey
func nestedUnkeyedContainer(forKey key: Self.Key) -> UnkeyedEncodingContainer Required

Stores an unkeyed encoding container for the given key and returns it.

  • parameter key: The key to encode the container for.

Declaration

mutating func nestedUnkeyedContainer(forKey key: Self.Key) -> UnkeyedEncodingContainer
func superEncoder() -> Encoder Required

Stores a new nested container for the default super key and returns A new encoder instance for encoding super into that container.

Equivalent to calling superEncoder(forKey:) with Key(stringValue: "super", intValue: 0).

Declaration

mutating func superEncoder() -> Encoder
func superEncoder(forKey key: Self.Key) -> Encoder Required

Stores a new nested container for the given key and returns A new encoder instance for encoding super into that container.

  • parameter key: The key to encode super for.

Declaration

mutating func superEncoder(forKey key: Self.Key) -> Encoder