Struct ErrorResponse 

pub struct ErrorResponse {
    pub error: String,
    pub code: String,
}

JSON error response for API clients.

A standardized error response format returned by all PDF endpoints when an error occurs. This structure makes it easy for API clients to parse and handle errors programmatically.

Fields

Field	Type	Description
error	String	Human-readable error message
code	String	Machine-readable error code

Response Format

{
    "error": "Invalid URL: relative URL without a base",
    "code": "INVALID_URL"
}

Client-Side Handling

// TypeScript example
interface ErrorResponse {
    error: string;
    code: string;
}

async function convertToPdf(url: string): Promise<Blob> {
    const response = await fetch(`/pdf?url=${encodeURIComponent(url)}`);
     
    if (!response.ok) {
        const error: ErrorResponse = await response.json();
         
        switch (error.code) {
            case 'INVALID_URL':
                throw new Error('Please provide a valid URL');
            case 'BROWSER_UNAVAILABLE':
                // Retry after delay
                await sleep(1000);
                return convertToPdf(url);
            default:
                throw new Error(error.error);
        }
    }
     
    return response.blob();
}

Examples

use html2pdf_api::service::{PdfServiceError, ErrorResponse};

let error = PdfServiceError::InvalidUrl("missing scheme".to_string());
let response = ErrorResponse::from(error);

assert_eq!(response.code, "INVALID_URL");
assert!(response.error.contains("Invalid URL"));

// Serialize to JSON
let json = serde_json::to_string(&response).unwrap();
assert!(json.contains("INVALID_URL"));

Fields

error: String

Human-readable error message.

This message is intended for developers and logs. It may contain technical details about the error cause. For user-facing messages, consider mapping the code field to localized strings.

code: String

Machine-readable error code.

A stable, uppercase identifier for the error type. Use this for programmatic error handling rather than parsing the error message.

See PdfServiceError::error_code() for the complete list of codes.

Trait Implementations

impl Clone for ErrorResponse

fn clone(&self) -> ErrorResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PdfServiceError> for ErrorResponse

fn from(err: &PdfServiceError) -> Self

Converts to this type from the input type.

impl From<PdfServiceError> for ErrorResponse

fn from(err: PdfServiceError) -> Self

Converts to this type from the input type.

impl Serialize for ErrorResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.