Documents and IDs

  • A document belonging to a DittoCollection with an inner value.

    See more

    Declaration

    Swift

    public class DittoDocument
    extension DittoDocument: CustomStringConvertible, CustomDebugStringConvertible
    extension DittoDocument: Identifiable
  • Provides an interface to specify a path to a key in a document that you can then call a function on to get the value at the specified key as a specific type. You obtain a DittoDocumentPath by subscripting a DittoDocument and you can then further subscript a DittoDocumentPath to further specify the key of the document that you want to get the value of.

    See more

    Declaration

    Swift

    public struct DittoDocumentPath
  • This is used as part of update operations for documents. It provides access to updating a document through a subscript-based API. A subscript operation returns a DittoMutableDocumentPath that you can then use to chain further subscript operations to in order to access nested values in a document. Once you’ve defined the path to a key in a document that you’d like to update, by using subscripts, then you can use the functionality defined on DittoMutableDocumentPath to perform the desired document update(s). Note that objects of this type should only be used within the scope of the update closure that they are provided in.

    See more

    Declaration

    Swift

    public class DittoMutableDocument
  • Provides an interface to specify a path to a key in a document that you can then call various update functions on. You obtain a DittoMutableDocumentPath by subscripting a DittoMutableDocument and you can then further subscript a DittoMutbaleDocumentPath to further specify the key of the document that you want to update.

    See more

    Declaration

    Swift

    public class DittoMutableDocumentPath: Swift.ExpressibleByStringLiteral,
        Swift.ExpressibleByIntegerLiteral, Swift.ExpressibleByBooleanLiteral,
        Swift.ExpressibleByFloatLiteral, Swift.ExpressibleByDictionaryLiteral,
        Swift.ExpressibleByArrayLiteral, Swift.ExpressibleByNilLiteral
  • An identifier for a DittoDocument.

    Each DittoDocumentID represents a unique identifier for a document.

    See more

    Declaration

    Swift

    public struct DittoDocumentID : Hashable
    extension DittoDocumentID: CustomStringConvertible, CustomDebugStringConvertible
    extension DittoDocumentID: ExpressibleByStringLiteral
    extension DittoDocumentID: ExpressibleByBooleanLiteral
    extension DittoDocumentID: ExpressibleByIntegerLiteral
    extension DittoDocumentID: ExpressibleByArrayLiteral
    extension DittoDocumentID: ExpressibleByDictionaryLiteral
  • Provides an interface to specify a path to a key in a document ID that you can then call a function on to get the value at the specified key as a specific type. You obtain a DittoDocumentIDPath by subscripting a DittoDocumentID and you can then further subscript a DittoDocumentIDPath to further specify the key of the document ID that you want to get the value of. This is only really useful if you’re working with a document ID whose underlying value is a dictionary or an array.

    See more

    Declaration

    Swift

    public struct DittoDocumentIDPath
  • A document belonging to a DittoCollection with an inner typed value.

    See more

    Declaration

    Swift

    public class DittoTypedDocument<T> where T : Decodable