Skip to main content

Rust Crate API

This page covers the public Rust crate surface. The site also serves the full bundled rustdoc so Rust consumers can browse the real crate API directly.

The full crate rustdoc is bundled into this site from src/lib.rs.

Full crate reference​

Re-export map​

auth​

  • AuthClaims
  • AuthenticatedSyncFrame
  • DataCertificate
  • EncryptedSyncFrame
  • inspect_signed_field_value
  • InspectedSignedFieldValue
  • LocalUser
  • owner_public_key_for_path
  • SecureSyncFrame
  • SecurityState
  • SignedValueClaims
  • StoredSnapshot
  • UserGrant
  • UserRecord

binary​

  • BinaryBytes

blob​

  • blob_ref_for_data
  • BlobRef
  • BlobStorageBinding
  • BlobStorageConfig
  • BlobStore
  • FileBlobStore
  • MemoryBlobStore
  • StoredBlob

clock​

  • HybridClock
  • Revision
  • VersionMarker

compat​

  • Gun
  • GunChain
  • GunCompatOptions

crypto​

  • EncryptedPayload
  • Identity
  • PublicIdentity
  • SeaPair
  • SecretBoxKey
  • SignedPayload

db​

  • Chain
  • ChangeEvent
  • ChangeSubscription
  • LexBuilder
  • MapEntry
  • Primadb
  • QueryBuilder
  • Subscription
  • VacuumReport

durable​

  • DurableStorageBinding
  • DurableStorageConfig

engine​

  • AuthNodeMeta
  • build_storage_metadata
  • build_storage_transaction
  • build_storage_transaction_from_ops
  • direct_index_encode_prefix
  • direct_index_key
  • DirectIndexScan
  • DirectScalarIndexEntry
  • encode_component
  • IncrementalStore
  • node_matches_root
  • NodeIndexManifest
  • operation_matches_root
  • SegmentFileStore
  • sortable_scalar_key
  • StorageMetadata
  • StorageTransaction
  • StorageVacuumReport
  • StoredAuthFieldMeta
  • touched_nodes
  • touched_storage_nodes

error​

  • PrimadbError
  • Result

hardening​

  • PrimadbLimits
  • PrimadbStats

hooks​

  • ConnectHookContext
  • HookDecision
  • HookTransport
  • NetworkHooks
  • parse_request_hook_json
  • parse_result_hook_json
  • parse_void_hook_json
  • RoomHookContext
  • ServeRequestContext
  • ServeResultContext

native_mesh​

  • NativeWebRtcMesh

native_sync​

  • NativeWebSocketSync

net​

  • IceServerConfig
  • IceServerUrls
  • MeshConfig
  • MeshSignal
  • MeshSignalingMode
  • RelayClientConfig

operation​

  • Operation
  • OperationAction
  • OperationValue

parallel​

  • parallel_enabled
  • parallel_thread_count

query​

  • LexEntry
  • LexSpec
  • QueryDirection
  • QueryFilter
  • QueryOrder
  • QuerySpec

router​

  • PeerPresence
  • PeerRecommendation
  • RouteBatchItem
  • RouteDecision
  • RouteEnvelope
  • RoutePayload
  • Router
  • RouterConfig
  • RouterStats
  • RouteTarget

snapshot​

  • DatabaseSnapshot

storage​

  • MemoryStorageAdapter
  • RadiskFileAdapter
  • SnapshotFileAdapter
  • StorageAdapter
  • StorageReport

sync​

  • error_pull_response
  • error_watch_event
  • PullChunk
  • PullRequest
  • PullRequestKind
  • PullResponse
  • PullResponseBody
  • RemotePath
  • RemoteResult
  • RemoteWatchMessage
  • RemoteWatchSubscription
  • stable_content_hash
  • SyncEnvelope
  • SyncFrame
  • WatchEvent
  • WatchRequest
  • WatchRequestKind

value​

  • FieldState
  • FieldValue
  • NodeId
  • NodeState
  • SetState