SipHasher

public struct SipHasher

An implementation of the SipHash-2-4 hashing algorithm, suitable for use in projects outside the Swift standard library. (The Swift stdlib already includes SipHash; unfortunately its API is not public.)

SipHash was invented by Jean-Philippe Aumasson and Daniel J. Bernstein.

Initializers

  • Initialize a new instance with the default key, generated randomly the first time this initializer is called.

    Declaration

    Swift

    public init()
    Show on GitHub

  • Initialize a new instance with the specified key.

    Parameter

    Parameter k0: The low 64 bits of the secret key.

    Parameter

    Parameter k1: The high 64 bits of the secret key.

    Declaration

    Swift

    public init(k0: UInt64, k1: UInt64)

    Parameters

    k0

    The low 64 bits of the secret key.
    k1

    The high 64 bits of the secret key.
    Show on GitHub

Appending data

  • Add all bytes in buffer to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ buffer: UnsafeRawBufferPointer)
    Show on GitHub

Finalization

  • Finalize this hash and return the hash value.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func finalize() -> Int
    Show on GitHub

Appending Hashable Values

  • Add hashing components in value to this hash. This method simply calls value.addHashes.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append<H: SipHashable>(_ value: H)
    Show on GitHub

  • Add the hash value of value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append<H: Hashable>(_ value: H)
    Show on GitHub

Appending Integers

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Bool)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Int)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: UInt)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Int64)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: UInt64)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Int32)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: UInt32)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Int16)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: UInt16)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Int8)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: UInt8)
    Show on GitHub

Appending Floating Point Types

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Float)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Double)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: Float80)
    Show on GitHub

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append(_ value: CGFloat)
    Show on GitHub

Appending Optionals

  • Add value to this hash.

    Requires

    finalize() hasn’t been called on this instance yet.

    Declaration

    Swift

    public mutating func append<Value: Hashable>(_ value: Value?)
    Show on GitHub