DocumentID

@propertyWrapper
public struct DocumentID<Value: DocumentIDWrappable & Codable>:
  StructureCodingUncodedUnkeyed

extension DocumentID: Codable

extension DocumentID: Equatable where Value: Equatable

extension DocumentID: Hashable where Value: Hashable

A property wrapper type that marks a DocumentReference? or String? field to be populated with a document identifier when it is read.

Apply the @DocumentID annotation to a DocumentReference? or String? property in a Codable object to have it populated with the document identifier when it is read and decoded from Firestore.

• Example Read:

  struct Player: Codable {
  @DocumentID var playerID: String?
  var health: Int64
  }
  

let p = try! await Firestore.firestore() .collection("players") .document("player-1") .getDocument(as: Player.self) print("(p.playerID!) Health: (p.health)")

// Prints: "Player: player-1, Health: 95"

- Important: Trying to encode/decode this type using encoders/decoders other than
  Firestore.Encoder throws an error.

- Important: When writing a Codable object containing an `@DocumentID` annotated field,
  its value is ignored. This allows you to read a document from one path and
  write it into another without adjusting the value here.