Expand description
§api-fetch
This crate is an alias for better-fetch: same types,
same API, alternate name on crates.io.
Modules§
- auth
- backend
- cancel
- Request cancellation (
CancellationToken) compatible with cooperative async abort. - client
- endpoint
- error
- hooks
- Lifecycle hooks for requests and responses.
- plugin
- Plugin hooks run after URL construction and auth, before request lifecycle hooks.
- plugins
- request
- response
- retry
Macros§
- endpoint
- Helper macro for simple endpoint definitions.
Structs§
- Cancellation
Token - A token which can be used to signal a cancellation request to one or more tasks.
- Client
- Typed HTTP client built on reqwest.
- Client
Builder - Builder for
Client. - Client
Config - Shared client configuration.
- Endpoint
Request Builder - Fluent builder for a typed
Endpoint. - Error
Context - Context when an error occurs.
- Hooks
- Lifecycle hooks for the HTTP client.
- Http
Request - Prepared HTTP request passed to a backend.
- Http
Response - Raw HTTP response from a backend.
- Logger
Plugin - Tracing-based logger plugin (request, response, retry, error).
- Plugin
Registry - Ordered plugin list.
- Prepared
Request - Prepared request state passed to plugin
Plugin::init. - Request
Builder - Fluent builder for a single HTTP request.
- Request
Context - Context for an outgoing request.
- Reqwest
Backend - Reqwest-backed HTTP backend.
- Response
- HTTP response wrapper.
- Response
Context - Context after a response is received.
- Success
Context - Context after a successful HTTP response (2xx).
Enums§
- Auth
- Authentication configuration for a client or request.
- Error
- Error type for better-fetch operations.
- Http
Body - Request body encoding for the transport layer.
- Query
Value - Query parameter value (scalar or repeated).
- Retry
Policy - Retry policy configuration.
- Token
Source - Source for credential values (static, sync, or async).
Traits§
- Async
Token Provider - Async token resolver.
- Endpoint
- Describes a typed API route.
- Endpoint
Params - Applies path parameters to a
RequestBuilder. - Endpoint
Query - Applies query parameters to a
RequestBuilder. - Http
Backend - Plugin
- Plugin extension point for better-fetch.
Functions§
- default_
should_ retry - json_
parser - Wraps a custom JSON parse function for use with
ClientBuilder::json_parser. - parse_
retry_ after - Parses
Retry-Afteras a delay in seconds (integer values only). - serde_
json_ parser - Default parser using
serde_json::from_slice(same semantics as the fast path, as aJsonParserFn).
Type Aliases§
- Json
Parser Fn - Parses response bytes into
serde_json::Valuebefore deserializing toT. - Result
- Result alias using
Error. - Should
Retry Fn - Predicate for whether a response should be retried.