Enum ApiError 

pub enum ApiError {
    InvalidRequestError(InvalidRequestError),
    CrateNotFoundError(CrateNotFoundError),
    ModuleNotFoundError(ModuleNotFoundError),
    ItemNotFoundError(ItemNotFoundError),
    UnsupportedRustdocFormatError(UnsupportedRustdocFormatError),
    SourceUnavailableError(SourceUnavailableError),
    OperationFailedError(OperationFailedError),
}

Typed failure returned in place of a result.

JSON schema

{
 "description": "Typed failure returned in place of a result.",
 "oneOf": [
   {
     "title": "InvalidRequestError",
     "description": "The request violates the contract.",
     "$ref": "#/$defs/InvalidRequestError"
   },
   {
     "title": "CrateNotFoundError",
     "description": "No matching published crate exists.",
     "$ref": "#/$defs/CrateNotFoundError"
   },
   {
     "title": "ModuleNotFoundError",
     "description": "The requested public module is absent.",
     "$ref": "#/$defs/ModuleNotFoundError"
   },
   {
     "title": "ItemNotFoundError",
     "description": "The requested public item is absent.",
     "$ref": "#/$defs/ItemNotFoundError"
   },
   {
     "title": "UnsupportedRustdocFormatError",
     "description": "The rustdoc format is unsupported.",
     "$ref": "#/$defs/UnsupportedRustdocFormatError"
   },
   {
     "title": "SourceUnavailableError",
     "description": "Rustdoc data is temporarily unavailable.",
     "$ref": "#/$defs/SourceUnavailableError"
   },
   {
     "title": "OperationFailedError",
     "description": "The operation failed without a more specific classification.",
     "$ref": "#/$defs/OperationFailedError"
   }
 ]
}

Variants

InvalidRequestError(InvalidRequestError)

The request violates the contract.

CrateNotFoundError(CrateNotFoundError)

No matching published crate exists.

ModuleNotFoundError(ModuleNotFoundError)

The requested public module is absent.

ItemNotFoundError(ItemNotFoundError)

The requested public item is absent.

UnsupportedRustdocFormatError(UnsupportedRustdocFormatError)

The rustdoc format is unsupported.

SourceUnavailableError(SourceUnavailableError)

Rustdoc data is temporarily unavailable.

OperationFailedError(OperationFailedError)

The operation failed without a more specific classification.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CrateNotFoundError> for ApiError

fn from(value: CrateNotFoundError) -> Self

Converts to this type from the input type.

impl From<InvalidRequestError> for ApiError

fn from(value: InvalidRequestError) -> Self

Converts to this type from the input type.

impl From<ItemNotFoundError> for ApiError

fn from(value: ItemNotFoundError) -> Self

Converts to this type from the input type.

impl From<ModuleNotFoundError> for ApiError

fn from(value: ModuleNotFoundError) -> Self

Converts to this type from the input type.

impl From<OperationFailedError> for ApiError

fn from(value: OperationFailedError) -> Self

Converts to this type from the input type.

impl From<SourceUnavailableError> for ApiError

fn from(value: SourceUnavailableError) -> Self

Converts to this type from the input type.

impl From<UnsupportedRustdocFormatError> for ApiError

fn from(value: UnsupportedRustdocFormatError) -> Self

Converts to this type from the input type.

impl JsonSchema for ApiError

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ApiError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.