Module traits

Module traits 

Source
Expand description

Structs§

NoCursorStore
This cursor store always returns 0
NoopResolver
A resolver that does not even attempt to try and get dependencies
Resolved
TypedNoopResolver
XmtpEnvelope
Envelopes from the XMTP Network received from a general XmtpQuery

Enums§

CursorStoreError
EnvelopeError
ResolutionError

Traits§

ApplyCursor
Extension trait to modify a TopicCursor with the contents of an envelope.
CursorStore
Trait defining how cursors should be stored, updated, and fetched NOTE:, implementations decide retry strategy. the exact implementation of persistence (or lack) is up to implementors. functions are assumed to be idempotent & atomic.
Envelope
Represents a Single High-Level Envelope An Envelope is a ProtocolEnvelope with some Extractor applied to it. Envelopes received from the network generally must adhere to the form of envelopes expected in d14n Node2Node Protocol. In the network, Node operators are responseible for maintaining a Cursor per envelope. Likewise, Clients form the ClientEnvelope according to the Client Node2Node Protocol Client envelopes maintain a payload/topic with MLS and Client-specific duties.
EnvelopeCollection
A Generic Higher-Level Collection of Envelopes
EnvelopeVisitor
Envelope Visitor type for handling of serialized nested envelope types.
Extractor
An Extractor indicates a specific direction to process an [ProtocolEnvelope]. Extractor implementations are available in crate::protocol::extractors
FullXmtpApiT
Trait combining all other api traits into one Used for describing the entire XmtpApi from the client perspective in a single dyn Trait or otherwise requiring the full capabilities of the API. Requiring the full capabilities outside of a dyn should generally be avoided unless the consumer wants to be unnecessarily general/restrictive.
MaybeExtractor
OrderedEnvelopeCollection
A ordered envelope collection an OrderedEnvelopeCollection differs from Sort since it adds the including of async, allowing an OrderedEnvelopeCollection to both Sort and ResolveDependencies
ProtocolEnvelope
An low-level envelope from the network gRPC interface
ResolveDependencies
Sort
Envelopes in a d14n-context must be sorted according to its dependencies, and by-originator. XIP, cross-originator sorting
TryEnvelopeCollectionExt
Extension trait for an envelope collection which handles errors.
TryExtractor
Represents an Extractor whose output is a Result Useful for deriving traits that should be aware of Result Ok and Error values.
XmtpQuery
matching the cursor criteria given.

Type Aliases§

FullXmtpApiArc
A type-erased version of the Xntp Api in a Arc
FullXmtpApiBox
A type-erased version of the Xmtp Api in a Box