Enum Error 

#[non_exhaustive]
pub enum Error {
    BaseUrl {
        base: Url,
    },
    ClientBuild {
        source: Error,
    },
    RequestBody {
        operation: &'static str,
        source: Error,
    },
    UnsupportedParameter {
        operation: &'static str,
        parameter: &'static str,
        wire_version: WireVersion,
    },
    Transport {
        url: Url,
        source: Error,
    },
    Timeout {
        url: Url,
        source: Error,
    },
    ServerFailure {
        url: Url,
        upstream: Box<UpstreamError>,
    },
    Unauthorized {
        url: Url,
        challenge: Option<String>,
        upstream: Box<UpstreamError>,
    },
    Token {
        url: Url,
        source: TokenFailure,
    },
    Renewal {
        url: Url,
        upstream: Box<UpstreamError>,
        source: TokenFailure,
    },
    Refused {
        operation: &'static str,
        url: Url,
        upstream: Box<UpstreamError>,
    },
    Body {
        operation: &'static str,
        url: Url,
        source: Box<BodyError>,
    },
    BatchArity {
        sent: usize,
        answered: usize,
    },
}

A call into the terminology server that did not reach an answer.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BaseUrl

The request could not be built into a URL under the configured base.

Fields

base: Url

The configured base URL.

ClientBuild

The HTTP client could not be built from the configuration.

Fields

source: Error

What the HTTP stack reported.

RequestBody

A request body could not be written as FHIR JSON.

Fields

operation: &'static str

The operation, as Resource/$code.

source: Error

What the encoder reported.

UnsupportedParameter

The request carries a parameter the configured release’s OperationDefinition does not declare and has no equivalent for, so nothing was sent.

STU3 ConceptMap/$translate has no url, and STU3 ValueSet/$validate-code has no valueSetVersion (https://hl7.org/fhir/STU3/terminology-service.html). Sending the request without the parameter would ask the server a different question than the caller asked.

Fields

operation: &'static str

The operation, as Resource/$code.

parameter: &'static str

The parameter, as the R4 OperationDefinition names it.

wire_version: WireVersion

The release the client is configured for.

Transport

The request never reached the server.

Fields

url: Url

The URL that was called.

source: Error

What the HTTP stack reported.

Timeout

The server did not answer inside the configured timeout.

Fields

url: Url

The URL that was called.

source: Error

What the HTTP stack reported.

ServerFailure

The server answered 5xx.

Fields

url: Url

The URL that was called.

upstream: Box<UpstreamError>

The upstream status and body.

Unauthorized

The server refused the credentials.

Fields

url: Url

The URL that was called.

challenge: Option<String>

The WWW-Authenticate challenge, when the server sent one.

upstream: Box<UpstreamError>

The upstream status and body.

Token

The token provider obtained no token, so nothing was sent.

Fields

url: Url

The URL the request was for.

source: TokenFailure

The provider’s failure.

Renewal

The server refused the token (401) and no new one could be obtained, so the request was not sent again.

Fields

url: Url

The URL that was called.

upstream: Box<UpstreamError>

The upstream status and body of the refusal.

source: TokenFailure

The provider’s failure.

Refused

The server refused the operation.

Fields

operation: &'static str

The operation, as Resource/$code.

url: Url

The URL that was called.

upstream: Box<UpstreamError>

The upstream status and body, with any tx-issue-type coding.

Body

The response body could not be decoded.

Fields

operation: &'static str

The operation, as Resource/$code.

url: Url

The URL that was called.

source: Box<BodyError>

What the decoder reported.

BatchArity

The batch answered a different number of entries than were sent.

Fields

sent: usize

How many requests were sent.

answered: usize

How many entries came back.

Implementations

impl Error

pub fn kind(&self) -> &'static str

Returns the variant’s name as a short kebab-case label, for a log line that must name the failure class and never the URL or a body.

pub fn upstream_status(&self) -> Option<StatusCode>

Returns the status the terminology server answered with, when the failure is an answer: a 5xx, a refused credential or a refused operation. A call that never reached an answer has none.

pub fn is_retryable(&self) -> bool

Returns whether a retry of the same request could succeed.

Only a failure that did not reach the server, or one the server reported as its own (5xx), is transient. The three operations declare affectsState: false (OperationDefinition-CodeSystem-lookup, OperationDefinition-ConceptMap-translate and OperationDefinition-ValueSet-validate-code, R4B), so a repeat is the same read and the POST form is retried like the GET form (https://hl7.org/fhir/R4/operations.html). The STU3 definitions of the same operations declare no such flag; retrying them on the same ground is our own design.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.