EncryptedKey

struct EncryptedKey

Encrypted keys that are used to identify values in a storage backend.

  • The size of the key in bytes.

    Declaration

    Swift

    public static let SizeInBytes: UInt32
    Show on GitHub

  • The personalized hash of the plaintext key.

    Declaration

    Swift

    let value: GenericHash
    Show on GitHub

  • Initialize an encrypted key.

    Declaration

    Swift

    init?(_ value: GenericHash)

    Parameters

    value

    The personalized has of the plaintext key.

    Return Value

    nil if the size is incorrect.

    Show on GitHub

Backend

  • Compare two encrypted keys. Keys need to be comparable in order to do lookups.

    Declaration

    Swift

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

    Parameters

    lhs

    An encrypted key.
    rhs

    Another encrypted key.

    Return Value

    true if and only if lhs equals to rhs.

    Show on GitHub

Backend

  • The hash value, for being able to use encrypted keys in dictionaries or sets. This should not be confused with the personalized hash of the plaintext key.

    Declaration

    Swift

    public var hashValue: Int { get }
    Show on GitHub

Backend

  • A textual representation of an encrypted key.

    Declaration

    Swift

    public var description: String { get }
    Show on GitHub