Structures

The following structures are available globally.

  • Metadata describing the conditions of the build of this software.

    See more

    Declaration

    Swift

    public struct BuildMetadata
    extension BuildMetadata: Sendable
    extension BuildMetadata: Equatable, Hashable

  • Information returned when a commit is created.

    See more

    Declaration

    Swift

    public struct CommitBundle
    extension CommitBundle: Sendable

  • This directly represents a ClientId of the <userid>:<device-id>@<domain> format. Instantiate via [ClientId::deserialize].

    Its Display reproduces the bytes of the [ClientId] it came from, so the device id is rendered as unpadded hex. Note that this differs from [DeviceId::to_hex_string], which is fixed-width: a client id is not a hex-encoded binary value, and only the unpadded form matches what an E2EI certificate carries.

    See more

    Declaration

    Swift

    public struct DeserializedClientId
    extension DeserializedClientId: Sendable

  • A GroupInfo with associated metadata.

    See more

    Declaration

    Swift

    public struct GroupInfoBundle
    extension GroupInfoBundle: Sendable
    extension GroupInfoBundle: Equatable, Hashable

  • A HistorySecret encodes sufficient client state that it can be used to instantiate an ephemeral client.

    See more

    Declaration

    Swift

    public struct HistorySecret
    extension HistorySecret: Sendable

  • An HttpHeader used for PKI hooks.

    See more

    Declaration

    Swift

    public struct HttpHeader
    extension HttpHeader: Sendable
    extension HttpHeader: Equatable, Hashable

  • An HttpResponse used for PKI hooks.

    See more

    Declaration

    Swift

    public struct HttpResponse
    extension HttpResponse: Sendable
    extension HttpResponse: Equatable, Hashable

  • Encapsulates a prekey id and a CBOR-serialized prekey.

    See more

    Declaration

    Swift

    public struct ProteusAutoPrekeyBundle
    extension ProteusAutoPrekeyBundle: Sendable
    extension ProteusAutoPrekeyBundle: Equatable, Hashable

  • The identity claims identifying a client.

    Those claims are verifiable by any member in the group.

    See more

    Declaration

    Swift

    public struct WireIdentity
    extension WireIdentity: Sendable

  • Configuration for an X509 credential acquisition flow.

    See more

    Declaration

    Swift

    public struct X509CredentialAcquisitionConfiguration
    extension X509CredentialAcquisitionConfiguration: Sendable

  • Fields from a WireIdentity that are specific to X509 credentials.

    See more

    Declaration

    Swift

    public struct X509Identity
    extension X509Identity: Sendable
    extension X509Identity: Equatable, Hashable