Crate riffdb_client_rust 

Typed public gRPC client for RiffDB.

This crate contains transport ergonomics only. Contract validation, authorization, idempotency, command execution, and durable recovery remain server-owned semantics.

Modules

app_v1

Exact symbolic application wire types used by the typed transport client. Symbolic application API v1.

generated

Boundaries implemented by contract-generated ergonomic modules. Stable boundary for compiler-generated Rust command modules.

v1

Exact public wire types used by the typed transport client.

Structs

ApplicationCatalogFeatureView

One checked symbolic application feature view.

ApplicationCatalogPreflight

Checked feature-preflight result for one exact application contract.

ApplicationCommand

One symbolic command invocation with only name-addressed input.

ApplicationCommandResult

Successful command completion without kernel protocol details.

ApplicationContextualBatch

One bounded contextual pull.

ApplicationContextualHydration

One freshly executed hydration in a contextual work item.

ApplicationContextualReaction

One currently authorized declared reaction.

ApplicationContextualWorkItem

One leased event with fresh same-snapshot context and authorized reactions.

ApplicationError

One fully checked bounded application-semantic failure.

ApplicationErrorContext

Bounded symbolic context for one application failure.

ApplicationEvent

Safe symbolic event selected by the compiled stream definition.

ApplicationEventBatch

One bounded consumer response.

ApplicationEventConsumer

Checked durable consumer identity including the bounded caller-owned name.

ApplicationEventConsumerStatus

Bounded durable consumer status.

ApplicationEventDelivery

One attempt-specific leased event.

ApplicationEventId

Stable symbolic event identity.

ApplicationEventLeaseEvidence

Minimal exact evidence required to mutate one live event lease.

ApplicationEventProgressCursor

Opaque protected-consumer continuation. No event identity or checkpoint is recoverable from these bytes.

ApplicationEventResponseStream

Stream of checked, application-safe durable consumer batches.

ApplicationExportOperationId

The caller-stable identifier of one symbolic application export.

ApplicationExportSelectionV1

Exact caller-selected subset of one current V5 lineage grant.

ApplicationInstallationCampaignId

The caller-stable identifier of one application installation campaign.

ApplicationLiveQueryStream

Stream of closed application-safe live-query updates.

ApplicationProtectedEventConsumerStatus

Metadata-safe status for a row-policy-protected consumer.

ApplicationReactiveOperation

Exact immutable reactive operation selected by generated code.

ApplicationRecord

One name-addressed returned record.

ApplicationResultField

One top-level query result field.

ApplicationSessionConfigurationError

Invalid local construction of one exact application-session identity.

ApplicationSessionIdentity

Exact immutable application identity selected by one optional session.

ApplicationSourceSpan

Checked half-open source span in submitted RiffQL.

ApplicationUuid

Canonical UUID value with lazy display text.

ApplyContractMigration

One immutable confirmed migration apply with caller-stable identity.

ArchiveNameV1

A checked operator-configured archive name, never a filesystem path or URI.

AttemptBudget

A caller-selected nonzero bound on total transport submissions.

BackupNameV1

A checked immutable backup name beneath the server-owned backup root.

BearerCredential

One bounded POC capability bearer credential.

BootstrapCallMetadata

Checked metadata available only to loopback bootstrap capability creation.

BootstrapCapabilityCreateTemplate

A checked immutable bootstrap capability-create operation.

BootstrapCredential

One bounded credential for the loopback-only bootstrap call.

CallMetadata

Checked metadata applied consistently to one SDK call.

CanonicalVector

Freshness policy and commit token types used by projected queries. A validated, dimension-checked vector of f32 values in canonical form.

CheckContractMigration

One immutable read-only migration check with caller-stable identity.

CommitNotificationStream

A commit-notification stream decoded by the strict client codec.

CommitSequence

A single-node application commit sequence.

CommitToken

Freshness policy and commit token types used by projected queries. An opaque, scoped commit identity used as a causal freshness fence.

ContractMigrationOperationId

The caller-stable identifier of one contract migration operation.

CreateOfflineBackup

One checked immutable offline-backup creation.

DatabaseAlias

A canonical, non-secret database selector.

EventConsumerOptions

Bounded pull/stream policy accepted by the public consumer service.

EventConsumerResponseStream

A durable event-consumer stream decoded by the strict client codec.

GeneratedBatchItem

One independently completed generated command at its stable input offset.

GeneratedBatchOptions

Bounds for generated command batches.

GeneratedBatchProgress

Bounded progress safe to persist without command inputs or outcomes.

GeneratedBatchResult

Stable per-item generated batch result and resumable item checkpoint.

GeneratedExecution

A generated outcome together with its complete checked transport response.

IdempotentCommand

One immutable idempotent command used by every automatic retry attempt.

LiveQueryCheckpoint

Live-query convergence frontier and reconnect cursor.

LiveQueryCursor

Opaque consistency cursor safe to persist and return on reconnect.

LiveQueryPatch

One bounded keyed patch.

LiveQueryTerminal

Terminal live-query reason and last non-secret frontier.

LiveQueryUpdateStream

A live named-query stream decoded by the strict client codec.

MigrationBundleHash

The hash of one canonical compiled migration bundle.

NamedQuery

One named query invocation pinned optionally to an immutable module hash.

NamedQueryResult

Complete one-snapshot named query result.

NormalCapabilityCreateTemplate

A checked immutable normal capability-create operation.

OfflineMaintenanceOperationId

The caller-stable identifier of one offline maintenance operation.

OutcomeUnknown

The public client’s explicit unresolved idempotent-operation disposition.

ProjectedAggregateGroup

One aggregate group: key cells and aggregate cells.

ProjectedOrder

One sort key addressed by projected field name.

ProjectedQuery

Typed projected-query request builder.

ProjectedReadyRow

One Ready projected row: select cells and primary-key components.

ProjectionFrontier

Freshness policy and commit token types used by projected queries. An opaque, scoped projection visibility frontier.

ProtocolFailure

A bounded protocol failure containing no peer-provided text or bytes.

PublicError

A failure safe to display, serialize, or map at a public transport boundary.

QueryOptions

Typed execution options shared by every generated named query.

QueryResponseIdentity

Exact server-returned identity for one named query execution.

RequestId

The identifier of one transport submission.

RestoreArchivedBackup

One immutable archive restore whose archive selection is frozen by its durable receipt.

RestoreOfflineBackup

One checked immutable offline-backup restore.

RetireOfflineBackup

One checked immutable offline-backup retirement.

RiffDbClient

Typed clients for every service in the public riffdb.v1 API.

StableApplicationClient

Application-only client facade.

StartApplicationExport

One immutable exact application-export start or replay submission.

StartApplicationInstallation

One immutable exact application-installation start or resume submission.

StartApplicationReimport

One immutable, exact application-reimport start submission.

StartOfflineStorageScrub

One selector-free offline storage scrub (ADR-0203). Its only input is the caller-stable operation ID: there is no target, scope, or validation choice.

SystemIdSource

Stateless production source for client-owned UUIDv7 values.

TenantId

A bounded exact tenant identifier.

TraceParent

One bounded outbound traceparent metadata value.

TypedCommandResult

Typed generated command result without kernel protocol exposure.

TypedContextualBatch

One generated contextual pull.

TypedContextualWorkItem

One generated event plus its contextual work and lease evidence.

TypedEventBatch

One bounded generated consumer batch.

TypedEventDelivery

One generated typed event together with its exact lease evidence.

TypedLiveQueryReset

One generated complete reset with its reason and reconnect frontier.

TypedLiveQuerySnapshot

One generated complete snapshot with its exact reconnect frontier.

TypedLiveQueryStream

Generated closed live-query stream.

TypedQueryResult

Typed generated result with its snapshot and pagination metadata.

ValidationIssue

One stable validation code associated with a structured path.

ValidationIssues

A non-empty bounded collection of validation issues.

ValidationPath

A bounded path to a value that failed validation.

VectorInspectionPage

One bounded policy-filtered vector-state page.

VectorModelVersionItem

One policy-visible outdated model observation.

VectorModelVersionSummary

Whole-partition model-version summary, returned only when policy permits counts.

VectorStalenessItem

One policy-visible stale entity observation.

VectorStalenessSummary

Whole-partition staleness summary, returned only when policy permits counts.

VectorStateInspection

One symbolic bounded vector-state inspection request.

VerifiedTlsConnector

Stateful verified-TLS connector with atomic trust-root replacement.

Enums

ApplicationCardinality

Query result cardinality declared in RiffQL.

ApplicationCatalogFeature

Closed application feature vocabulary returned by symbolic catalog preflight.

ApplicationCatalogFeatureState

Availability of one closed application feature.

ApplicationClientError

Closed application-client failure.

ApplicationContract

Active or exact symbolic contract selection.

ApplicationErrorCategory

Coarse application failure category.

ApplicationErrorCode

Closed stable code registry for application-semantic failures.

ApplicationEventCheckpoint

Durable consumer checkpoint.

ApplicationEventConsumerPublicStatus

Public consumer status selected by the stream’s authorization model.

ApplicationEventMutationResult

Closed result for consumer metadata mutations.

ApplicationEventPullDisposition

Closed completion class for one bounded pull.

ApplicationFixCode

Closed machine-actionable remediation.

ApplicationLiveQueryUpdate

Closed application live-query update.

ApplicationOperation

Closed application operation inventory used only for public-safe context.

ApplicationRecoveryAction

Closed application recovery action.

ApplicationValue

A bounded application value addressed only by contract names.

ArchiveRestoreStopV1

Exact application-sequence selection for an offline archive restore.

BackupNameV1Error

A safe backup-name validation failure.

BearerCredentialFileError

A closed, redaction-safe failure to load one protected bearer credential.

CapabilityApplicationExportScopeV1

Closed V1 scope for one lineage-scoped application export grant.

CapabilityApplicationReimportScopeV1

Closed V1 scope for one exact application-reimport campaign grant.

CapabilityCreateTemplateError

A closed local failure while constructing a capability-create template.

ClientError

A closed failure returned by the Rust SDK.

CommandShapeError

A safe local error while constructing an immutable command submission.

ContractMigrationSubmissionError

A safe local failure while constructing immutable migration input.

DetailsFreeStatus

A valid details-free status from a closed non-PublicError boundary.

ErrorClass

A protocol-neutral classification for a public failure.

FreshnessPolicy

Freshness policy and commit token types used by projected queries. Projected-query freshness policy (ADR-0086 §3).

GeneratedBatchError

Failure before a generated batch can submit any item.

GeneratedExecutionError

A closed failure while executing one generated command shape.

IdempotentTransportBatchError

A local shape failure for one bounded transport batch of ordinary commands.

IdentifierGenerationError

A safe local failure while generating one client identifier.

LiveQueryPatchOperation

Closed keyed list mutation.

MetadataError

A safe local metadata-construction failure.

OfflineMaintenanceReplacementConfirmation

The caller’s exact destructive-replacement confirmation.

ProjectedAggregate

One aggregate function over a projected column.

ProjectedAggregateValue

One aggregate result cell.

ProjectedDegradedReason

Closed degraded reason codes from the wire.

ProjectedPredicate

Equality or range predicate addressed by projected field name.

ProjectedQueryOutcome

Typed projected-query outcome mirroring the wire oneof arms.

ProjectedRebuildingReason

Closed rebuilding reason codes from the wire.

ProjectedResponseEncoding

Wire encoding preference for a Ready projected-query response.

ProjectedSortDirection

Sort direction for one projected order key.

ProtocolFailureKind

The closed reason an untrusted gRPC failure was rejected.

PublicErrorDetails

Structured, caller-safe detail for a public failure.

PublicErrorKind

The closed set of failures that RiffDB may expose to an untrusted caller.

RecoveryAction

Safe, protocol-neutral recovery guidance for a public failure.

TlsClientFailure

Closed, path-redacted failure while constructing a verified TLS channel.

TlsTrustReloadStatus

Redacted disposition of the latest trust-root observation.

ValidationCode

A stable, caller-safe explanation for one validation failure.

ValidationPathSegment

One non-secret location component in a validation issue.

VectorStateInspectionKind

Closed population selected by an authoritative vector-state inspection.

VectorStateInspectionResult

Closed response shape. Count summaries and row-policy-filtered pages cannot be confused or silently substituted.

Constants

APPLICATION_SESSION_PROTOCOL_V1

Version of the first bounded application-session protocol.

DEFAULT_DATABASE_ALIAS

Compatibility alias assigned to the legacy single-database configuration.

MAX_APPLICATION_SESSION_IN_FLIGHT

Hard public ceiling for independently in-flight session operations.

MAX_GENERATED_BATCH_CONCURRENCY

Maximum independently in-flight items in one generated command batch.

Functions

generate_agent_session_id

Generates one optional caller agent-session identifier.

generate_application_export_operation_id

Generates one caller-stable symbolic-export operation identifier.

generate_application_installation_campaign_id

Generates one caller-stable application installation or reimport campaign identifier.

generate_capability_id

Generates one caller-selected capability identifier.

generate_contract_migration_operation_id

Generates one caller-stable contract-migration operation identifier.

generate_offline_maintenance_operation_id

Generates one caller-stable offline-maintenance operation identifier.

generate_request_id

Generates one fresh outer transport request identifier.

load_protected_bearer_credential

Loads one exact bearer presentation through the protected Linux file rule.