Struct PdfResponse 

pub struct PdfResponse {
    pub data: Vec<u8>,
    pub filename: String,
    pub force_download: bool,
}

Successful PDF generation result.

Contains the generated PDF binary data along with metadata for building the HTTP response. This type is returned by the core service functions and converted to framework-specific responses by the integrations.

Fields

Field	Type	Description
data	Vec<u8>	Raw PDF binary data
filename	String	Suggested filename for download
force_download	bool	Whether to force download vs inline display

HTTP Response Headers

When converted to an HTTP response, this generates:

Content-Type: application/pdf
Content-Disposition: inline; filename="document.pdf"  (or attachment if force_download)
Cache-Control: no-cache

Examples

use html2pdf_api::service::PdfResponse;

let response = PdfResponse::new(
    vec![0x25, 0x50, 0x44, 0x46], // PDF magic bytes
    "report.pdf".to_string(),
    false, // inline display
);

assert_eq!(response.content_disposition(), "inline; filename=\"report.pdf\"");

Fields

data: Vec<u8>

The generated PDF as raw binary data.

This is the complete PDF file content, ready to be sent as the HTTP response body or written to a file.

PDF Structure

Valid PDF data always starts with %PDF- (bytes 25 50 44 46 2D). You can verify the data is valid by checking this header:

fn is_valid_pdf(data: &[u8]) -> bool {
    data.starts_with(b"%PDF-")
}

filename: String

Suggested filename for the PDF download.

This is used in the Content-Disposition header. The actual filename used by the browser may differ based on user settings or browser behavior.

force_download: bool

Whether to force download instead of inline display.

• true: Uses Content-Disposition: attachment (forces download)
• false: Uses Content-Disposition: inline (displays in browser)

Implementations

impl PdfResponse

pub fn new(data: Vec<u8>, filename: String, force_download: bool) -> Self

Creates a new PDF response.

Arguments

• data - The raw PDF binary data
• filename - Suggested filename for the download
• force_download - Whether to force download vs inline display

Examples

use html2pdf_api::service::PdfResponse;

// For inline display
let response = PdfResponse::new(
    vec![0x25, 0x50, 0x44, 0x46],
    "invoice.pdf".to_string(),
    false,
);

// For forced download
let response = PdfResponse::new(
    vec![0x25, 0x50, 0x44, 0x46],
    "confidential-report.pdf".to_string(),
    true,
);

pub fn content_disposition(&self) -> String

Generates the Content-Disposition header value.

Returns a properly formatted header value based on the force_download setting.

Returns

• "attachment; filename=\"{filename}\"" if force_download is true
• "inline; filename=\"{filename}\"" if force_download is false

Examples

use html2pdf_api::service::PdfResponse;

let inline = PdfResponse::new(vec![], "doc.pdf".to_string(), false);
assert_eq!(inline.content_disposition(), "inline; filename=\"doc.pdf\"");

let download = PdfResponse::new(vec![], "doc.pdf".to_string(), true);
assert_eq!(download.content_disposition(), "attachment; filename=\"doc.pdf\"");

pub fn size(&self) -> usize

Returns the size of the PDF data in bytes.

Examples

use html2pdf_api::service::PdfResponse;

let response = PdfResponse::new(vec![0; 1024], "doc.pdf".to_string(), false);
assert_eq!(response.size(), 1024);

Trait Implementations

impl Clone for PdfResponse

fn clone(&self) -> PdfResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfResponse

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

Formats the value using the given formatter.