Crate prima_bridge

This crate gives a high level API to execute external HTTP requests.

It is supposed to give the basics building blocks for building bridges to other services while abstracting the low level stuff like adding custom headers and request tracing.

It supports both REST and GraphQL requests.

You should start by creating a Bridge instance. This instance should live for all the application lifetime.

Do not create a new bridge on every request!

You should use something like once_cell or lazy_static, or some sort of inversion of control container to pass around.

The bridge implement a type state pattern to build the external request.

Features

• auth0 - enable auth0 integration, allowing bridge.rs to retrieve tokens from auth0 for authentication
• gzip - provides response body gzip decompression.
• redis-tls - add support for connecting to redis with tls
• grpc - provides the GrpcOtelInterceptor for adding the opentelemetry context to the gRPC requests
• tracing_opentelemetry - adds support for integration with opentelemetry. This feature is an alias for the latest tracing_opentelemetry_x_xx feature.
• tracing_opentelemetry_x_xx (e.g. tracing_opentelemetry_0_27) - adds support for integration with a particular opentelemetry version. We are going to support at least the last 3 versions of opentelemetry. After that we might remove support for older otel version without it being a breaking change.

Re-exports

pub use self::builder::BridgeBuilder;

Modules

auth0auth0

Stuff used to provide JWT authentication via Auth0

builder

prelude

Structs

Body

A request body.

BridgeImpl

A Bridge instance that’s generic across the client. If the BridgeBuilder is used to construct a bridge with middleware, this type will be used to wrap the reqwest_middleware::ClientWithMiddleware.

Error

A struct representing a GraphQL error according to the GraphQL specification.

GraphQLRequest

The GraphQLRequest is a struct that represent a GraphQL request to be done with a crate::Bridge.

GrpcOtelInterceptorgrpc

A gRPC interceptor that injects the current tracing context into the request metadata.

MultipartFile

A multipart-form file, containing the file’s desired name, its MIME type, and its contents as an in-memory buffer or stream.

MultipartFormFileField

A named multipart-form field which contains a file.

Request

A utility type to construct requests more easily.

Response

A server response.

RestRequest

The RestRequest is a struct that represent a REST request to be done with a crate::Bridge.

Enums

GraphQLMultipart

A GraphQLRequest multipart body as according to this specification.

PossiblyParsedData

An error type to represent all possible outcomes of a GraphQL response deserialization.

RedirectPolicy

Determines how to handle HTTP redirects (3xx responses).

RestMultipart

A RestRequest multipart form body.

Traits

DeliverableRequest

Represents a request that is ready to be delivered to the server.

ParsedGraphqlResponseExt

Type Aliases

Bridge

The basic Bridge type, using a reqwest::Client as the client.

GrpcOtelInterceptedServicegrpc

Convenience type alias for a long type that’s returned from the with_interceptor() function of the tonic-generated gRPC client when used with GrpcOtelInterceptor.

ParsedGraphqlResponse

A type returned from parse_graphql_response function useful for getting full control of a GraphQL response.