Struct ConnectError 

pub struct ConnectError { /* private fields */ }

An error that captures the key pieces of information for Connect RPC: a code, an optional message, metadata (HTTP headers), and optional error details.

Implementations

impl ConnectError

pub fn new<S: Into<String>>(code: Code, message: S) -> Self

Create a new error with a code and message.

pub fn from_code(code: Code) -> Self

Create a new error with just a code.

pub fn new_unimplemented() -> Self

Create an unimplemented error.

pub fn new_invalid_argument<S: Into<String>>(message: S) -> Self

Create an invalid argument error.

pub fn new_not_found<S: Into<String>>(message: S) -> Self

Create a not found error.

pub fn new_permission_denied<S: Into<String>>(message: S) -> Self

Create a permission denied error.

pub fn new_unauthenticated<S: Into<String>>(message: S) -> Self

Create an unauthenticated error.

pub fn new_internal<S: Into<String>>(message: S) -> Self

Create an internal error.

pub fn new_unavailable<S: Into<String>>(message: S) -> Self

Create an unavailable error.

pub fn new_already_exists<S: Into<String>>(message: S) -> Self

Create an already exists error.

pub fn new_resource_exhausted<S: Into<String>>(message: S) -> Self

Create a resource exhausted error.

pub fn new_failed_precondition<S: Into<String>>(message: S) -> Self

Create a failed precondition error.

pub fn new_aborted<S: Into<String>>(message: S) -> Self

Create an aborted error.

pub fn code(&self) -> Code

Get the error code.

pub fn message(&self) -> Option<&str>

Get the error message.

pub fn details(&self) -> &[ErrorDetail]

Get the error details.

pub fn add_detail<S: Into<String>>(self, type_url: S, value: Vec<u8>) -> Self

Add an error detail with type URL and protobuf-encoded bytes.

Example

use prost::Message;

let duration = prost_types::Duration { seconds: 5, nanos: 0 };
let mut bytes = Vec::new();
duration.encode(&mut bytes).unwrap();

// Wrap in RetryInfo (field 1)
let mut retry_info_bytes = vec![0x0a, bytes.len() as u8];
retry_info_bytes.extend(bytes);

let err = ConnectError::new(Code::ResourceExhausted, "rate limited")
    .add_detail("google.rpc.RetryInfo", retry_info_bytes);

pub fn add_error_detail(self, detail: ErrorDetail) -> Self

Add a pre-constructed ErrorDetail.

pub fn meta(&self) -> Option<&HeaderMap>

Get the metadata headers, if any.

pub fn meta_mut(&mut self) -> &mut HeaderMap

Get mutable access to metadata headers. Lazily initializes the HeaderMap if not present.

pub fn with_meta<K, V>(self, key: K, value: V) -> Self

where K: AsRef<str>, V: AsRef<str>,

Add a metadata header.

pub fn set_meta_from_headers(self, headers: &HeaderMap) -> Self

Set metadata from HeaderMap.

impl ConnectError

pub fn into_streaming_response(self, use_proto: bool) -> Response

Create a streaming error response with proper EndStream framing.

Per the Connect protocol, streaming responses must:

• Always return HTTP 200
• Use application/connect+json or application/connect+proto content-type
• Deliver errors in an EndStream frame (flags = 0x02)

This method should be used by streaming handlers when returning errors before the stream has started. The use_proto flag determines the response encoding (protobuf vs JSON).

Trait Implementations

impl Clone for ConnectError

fn clone(&self) -> ConnectError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<(StatusCode, String)> for ConnectError

fn from(value: (StatusCode, String)) -> Self

Convert an HTTP status code and message into a ConnectError.

This provides a simple DX helper to lift common HTTP errors into Connect’s error space.

impl From<Infallible> for ConnectError

fn from(infallible: Infallible) -> Self

Converts to this type from the input type.

impl IntoResponse for ConnectError

fn into_response(self) -> Response

Create a response.

impl Serialize for ConnectError

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.