Struct ServerError 

pub struct ServerError { /* private fields */ }

A transport-neutral server error. Display shows the public message only. Debug shows the log detail as Redacted and replaces the value of every crate::NEVER_LOG header with a placeholder; a sink that knows deployment-configured names logs headers through crate::Redactor instead.

Implementations

impl ServerError

pub fn new(code: Code, public: impl Into<Cow<'static, str>>) -> Self

An error with code and a client-safe public message.

pub fn is_transport_admission_required(&self) -> bool

Whether a transport-identity (ssh or enc) pipeline refused because admission wants a payment or a reservation those transports cannot carry: the ssh binding answers “use mkit+https” for it, rather than a message that reads as a denied write.

pub fn invalid_argument(public: impl Into<Cow<'static, str>>) -> Self

Code::InvalidArgument.

pub fn unauthenticated(public: impl Into<Cow<'static, str>>) -> Self

Code::Unauthenticated.

pub fn permission_denied(public: impl Into<Cow<'static, str>>) -> Self

Code::PermissionDenied, with its default HTTP status (403).

pub fn admission_challenge(challenge: Bytes) -> Self

An admission challenge (SPEC-TRANSPORT-CONNECT §5.1): Code::PermissionDenied with HTTP status 402 and exactly one ADMISSION_CHALLENGE_TYPE detail. challenge is the encoded AdmissionChallenge message. Challenge headers such as WWW-Authenticate are added with Self::with_header.

pub fn not_found(public: impl Into<Cow<'static, str>>) -> Self

Code::NotFound.

pub fn repository_not_found() -> Self

Code::NotFound for a repository that is missing or unreadable without revealing which (SPEC-WRITE-GRANTS §9.3).

pub fn failed_precondition(public: impl Into<Cow<'static, str>>) -> Self

Code::FailedPrecondition.

pub fn resource_exhausted(public: impl Into<Cow<'static, str>>) -> Self

Code::ResourceExhausted: a client-attributable cap only (see Code).

pub fn aborted_retryable(public: impl Into<Cow<'static, str>>) -> Self

Code::Aborted: the same operation is in flight and the client may retry it unchanged (PRD §5.4 stage 0, in_flight replay records).

pub fn unavailable(public: impl Into<Cow<'static, str>>) -> Self

Code::Unavailable.

pub fn unimplemented(public: impl Into<Cow<'static, str>>) -> Self

Code::Unimplemented.

pub fn internal(public: &'static str, detail: impl Display) -> Self

A backend failure: a fixed public message, with detail kept only for server-side logs (issue #794).

pub fn with_http_status(self, status: u16) -> Self

Set the HTTP status the Connect binding answers with. Only error statuses (400..=599) are accepted, and 402 only on Code::PermissionDenied (use Self::admission_challenge). Any other value fails a debug assertion and is ignored.

pub fn try_with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Result<Self, InvalidHeader>

Add a response header from dynamic input, e.g. a value an admission helper produced.

Errors

InvalidHeader if the name is not an HTTP token, is reserved (a request credential, framing, hop-by-hop or cookie header), or the value holds a control character. self is dropped on error.

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Add a response header, e.g. WWW-Authenticate. An invalid or reserved header is dropped with a warning, so a credential or a framing header can never be echoed. A reserved name is a programming error and also fails a debug assertion; a malformed value never panics. Use Self::try_with_header to handle the failure instead.

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

Attach a typed error detail. An error carries at most one ADMISSION_CHALLENGE_TYPE detail (checked in debug builds).

pub fn code(&self) -> Code

The error category.

pub fn public_message(&self) -> &str

The client-safe message.

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

The server-side detail, for the log sink only.

pub fn http_status(&self) -> Option<u16>

The HTTP status override, if any.

pub fn headers(&self) -> &[(String, String)]

Response headers, in insertion order. Values may include receipts (crate::NEVER_LOG); log them through crate::Redactor.

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

Typed error details, in insertion order.

Trait Implementations

impl Clone for ServerError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerError

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

Formats the value using the given formatter.

impl Display for ServerError

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

Formats the value using the given formatter.

impl Error for ServerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<RefWireError> for ServerError

fn from(err: RefWireError) -> Self

The Connect code and message.

impl From<ServerError> for ConnectError

fn from(err: ServerError) -> Self

Converts to this type from the input type.

impl From<ServerError> for ResolveFailure

fn from(error: ServerError) -> Self

Converts to this type from the input type.

impl From<UploadError> for ServerError

fn from(err: UploadError) -> Self

The Connect code and message.