Skip to main content

Module api

Module api 

Source

Modules§

short_hex
stream
Default XMTP Stream

Structs§

ArcClient
An owned transport shared through an Arc.
BytesStream
concrete bytes stream type
FakeEmptyStream
This stream will always return Pending it should be used when subscribing with an empty topics list
Ignore
Concrete type of the ignore combinator
IgnoreSpecialized
NetworkError
A lower level NetworkError, like gRPC/QUIC/HTTP/1.1 errors go here. use ApiClientError::new to construct
RetryQuery
The concrete type of a crate::api::retry Combinators. Generally using the concrete type can be avoided with type inference or impl Trait.
RetrySpecialized
XmtpStream
A stream which maps the tonic error to ApiClientError, and attaches endpoint metadata

Enums§

ApiClientError
AuthError
Authentication failures with no credential or callback error text.
BodyError

Traits§

BoxClientT
Client
A client represents how a request body is formed and sent into a backend. The client is protocol agnostic, a Client may communicate with a backend over gRPC, JSON-RPC, HTTP-REST, etc. http::Response’s are used in order to maintain a common data format compatible with a wide variety of backends. an http response is easily derived from a grpc, jsonrpc or rest api.
Endpoint
provides the necessary information for a backend API call. Indicates the Output type
EndpointExt
HasStats
IsConnectedCheck
Query
Queries describe the way an endpoint is called. these are extensions to the behavior of specific endpoints.
QueryRaw
QueryStream
a companion to the Query trait, except for streaming calls. Not every query combinator/extension will apply to both steams and one-off calls (how do you ‘page’ a streaming api?), so these traits are separated.
QueryStreamExt
ToBoxedClient

Functions§

grpc_status
Find a typed gRPC status through transport and wrapper error sources.
ignore
Ignore/drop the response data for this endpoint does not ignore any errors that might have occurred as a result of making a network request. the response body still must be valid protobuf
retry
retry with the default retry strategy (ExponentialBackoff)
retry_with_strategy
Retry the endpoint, indicating a specific strategy to retry with

Type Aliases§

BoxClient
a boxed version of Client