DittoDocumentID

public struct DittoDocumentID : Hashable
extension DittoDocumentID: CustomStringConvertible, CustomDebugStringConvertible

An identifier for a DittoDocument.

Each DittoDocumentID represents a unique identifier for a document.

  • Initializes a new DittoDocumentID.

    A document ID can be created from any of the following:

    • string
    • integer
    • boolean
    • null
    • byte array
    • array (containing any of the items in this list)
    • map (where the keys must be strings and the values can be made up of any of the items in this list)

    Note that you cannot use floats or other custom types to create a document ID.

    Document IDs are also limited in size, based on their serialized representation, to 256 bytes. You will receive an error if you try to create a document ID that exceeds the size limit.

    Declaration

    Swift

    public init(value: Any)

    Parameters

    value

    The value that represents the document identifier.

  • Returns a native representation of a document identifier.

    Declaration

    Swift

    public func toNative() -> Any

    Return Value

    A value representing the document identifier.

  • Returns a stringified representation of a document identifier.

    The returned string can be used directly in queries that you use with other Ditto functions. For example you could create a query that was like this:

    myCollection.find("_id == \(docID.toString())")

    Declaration

    Swift

    public func toString() -> String

    Return Value

    An String representation of the document identifier.

  • Declaration

    Swift

    public static func == (lhs: DittoDocumentID, rhs: DittoDocumentID) -> Bool

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)

  • Undocumented

    Declaration

    Swift

    public func encode() -> [UInt8]

CustomStringConvertible & CustomDebugStringConvertible

  • Declaration

    Swift

    public var description: String { get }

  • Declaration

    Swift

    public var debugDescription: String { get }