Crate pdfkit 

pdfkit-rs

Safe Rust bindings for Apple’s PDFKit framework on macOS. The published Cargo package is pdfkit-rs; the Rust library target is pdfkit.

Status: v0.2.2 closes the remaining public PDFKit audit gaps with PdfActionResetForm, typed annotation key/subtype/icon constants, selection granularity and page-image initialization options, PdfViewDelegate, PdfPageOverlayViewProvider, and 100% coverage of the non-deprecated top-level SDK declarations counted by COVERAGE_AUDIT.md.

Highlights

• PdfDocument for loading, creating, mutating, saving, attaching delegates, option-driven writes, and granularity-aware selections
• PdfPage for bounds, text, character geometry, annotations, selections, and image-backed page creation
• PdfAction, PdfActionResetForm, PdfActionUrl, PdfActionGoTo, PdfActionNamed, and PdfActionRemoteGoTo for abstract and concrete action inspection/editing
• PdfAnnotation, PdfOutline, PdfBorder, PdfDestination, and typed annotation key/subtype/icon wrappers for navigation and form metadata
• PdfDocumentDelegate, PdfViewDelegate, PdfPageOverlayViewProvider, PdfDocumentWriteOptions, and structured PDFDocument / PDFView / PDFThumbnailView notification names
• PdfAppearanceCharacteristics, PdfPrintScalingMode, PdfTextAnnotationIconType, PdfThumbnailLayoutMode, PdfWidgetCellState, and PdfAccessibilityNode::public_api_available()

Quick start

use pdfkit::prelude::*;

fn main() -> std::result::Result<(), Box<dyn std::error::Error>> {
    let document = PdfDocument::from_url("document.pdf")?;
    let page = document
        .page(0)
        .ok_or_else(|| std::io::Error::other("missing first page"))?;
    let destination = PdfDestination::new(&page, PdfPoint { x: 36.0, y: 72.0 })?;
    let action = PdfActionGoTo::new(&destination)?;

    println!("pages={}", document.page_count());
    println!("first page text={:?}", page.string());
    println!("goto action type={:?}", action.action_type());
    Ok(())
}

Surface overview

Documents, pages, and selections

• PdfDocument::new, from_url, from_bytes, write_to_url, write_to_url_with_options
• PdfDocument::insert_page, remove_page, exchange_pages, set_outline_root, set_delegate, unlock
• PdfDocument::selection_for_entire_document, selection_from_page_points, selection_from_page_points_with_granularity, selection_from_page_characters
• PdfPage::new, from_image_data, bounds, set_bounds, rotation, set_rotation
• PdfPageImageInitializationOptions::{new, with_media_box, with_rotation, with_upscale_if_smaller, with_compression_quality}
• PdfPage::selection_for_range, selection_for_rect, selection_for_word_at_point, selection_for_line_at_point
• PdfSelection::new, text_range, selections_by_line, add_selection

Actions, outlines, and annotations

• PdfAction::action_type, as_url, as_goto, as_named, as_remote_goto, as_reset_form
• PdfActionResetForm::new, fields, set_fields, clear_fields, fields_included_are_cleared, set_fields_included_are_cleared, action_type
• PdfActionUrl::new, url, set_url, action_type
• PdfActionGoTo::new, destination, set_destination, action_type
• PdfActionNamed::new, name, set_name, action_type
• PdfActionRemoteGoTo::new, page_index, set_page_index, point, set_point, url, set_url, action_type
• PdfOutline::new, insert_child, set_label, set_destination, action, set_action, clear_action
• PdfAnnotation::new, new_with_subtype, info, set_contents, set_border, action, set_action, clear_action
• PdfAnnotationKey, PdfAnnotationHighlightingMode, PdfAnnotationLineEndingStyle, PdfAnnotationSubtype, PdfAnnotationTextIconName, PdfAnnotationWidgetSubtype
• PdfBorder::new, info, set_style, set_line_width, set_dash_pattern
• PdfDestination::new, info, page, set_zoom, compare

Delegates, notifications, and utilities

• PdfDocumentDelegate, PdfDocumentDelegateHandle, PdfViewDelegate, PdfViewDelegateHandle
• PdfPageOverlayViewProvider, PdfPageOverlayViewProviderHandle, PdfPageOverlayView
• PdfDocumentWriteOptions::{with_owner_password, with_user_password, with_access_permissions, with_burn_in_annotations, with_save_text_from_ocr, with_save_images_as_jpeg, with_optimize_images_for_screen}
• PdfDocumentNotification, PdfDocumentNotificationUserInfoKey, PdfViewNotification, PdfThumbnailViewNotification
• PdfActionNamedName, PdfLineStyle, PdfMarkupType, PdfPrintScalingMode, PdfSelectionGranularity, PdfTextAnnotationIconType, PdfThumbnailLayoutMode, PdfWidgetCellState

View state, widget appearance, and accessibility status

• PdfView::new, set_document, set_delegate, set_page_overlay_view_provider, set_display_mode, set_display_direction, set_display_box
• PdfView::set_current_selection, go_to_page, go_to_destination, visible_pages, area_of_interest_for_point
• PdfThumbnailView::new, set_pdf_view, set_thumbnail_size, set_maximum_number_of_columns
• PdfAppearanceCharacteristics::new, set_control_type, set_caption, set_background_color, info
• PdfAreaOfInterest, PdfDestination::UNSPECIFIED_VALUE, PdfAccessibilityNode::public_api_available, PdfAccessibilityNode::availability_note

Examples

The crate now ships smoke examples covering the core logical areas:

• 01_document_smoke
• 02_page_basics
• 03_annotation_link
• 04_outline_tree
• 05_selection_ranges
• 06_view_state
• 07_thumbnail_view_state
• 08_action_url
• 09_action_goto
• 10_border_style
• 11_destination_compare
• 12_appearance_characteristics
• 13_accessibility_node_status
• 14_action_named_remote_goto
• 15_document_delegate_write_options

Run one example:

cargo run --example 06_view_state

Run all examples:

for ex in examples/*.rs; do cargo run --example "$(basename "$ex" .rs)"; done

Coverage audit

See COVERAGE.md for the v0.2.2 header audit and COVERAGE_AUDIT.md for the symbol-level 100% audit report.

License

Licensed under either of Apache-2.0 or MIT at your option.

---

API Documentation

Safe Rust bindings for Apple’s PDFKit framework on macOS.

Modules

prelude

Re-exports the primary PDFKit wrapper types.

Structs

PdfAccessibilityNode

Wraps PDFAccessibilityNode.

PdfAction

Wraps PDFAction.

PdfActionGoTo

Wraps PDFActionGoTo.

PdfActionNamed

Wraps PDFActionNamed.

PdfActionRemoteGoTo

Wraps PDFActionRemoteGoTo.

PdfActionResetForm

Wraps PDFActionResetForm.

PdfActionUrl

Wraps PDFActionURL.

PdfAnnotation

Wraps PDFAnnotation.

PdfAnnotationInfo

Snapshot of PDFAnnotation state.

PdfAppearanceCharacteristics

Wraps PDFAppearanceCharacteristics.

PdfAppearanceCharacteristicsInfo

Snapshot of PDFAppearanceCharacteristics state.

PdfAreaOfInterest

Wraps PDFView area-of-interest.

PdfBorder

Wraps PDFBorder.

PdfBorderInfo

Snapshot of PDFBorder state.

PdfColor

Wraps RGBA color values used by PDFKit.

PdfDestination

Wraps PDFDestination.

PdfDestinationInfo

Snapshot of PDFDestination state.

PdfDocument

Wraps PDFDocument.

PdfDocumentAttributes

Wraps PDFDocumentAttributes.

PdfDocumentDelegateHandle

Wraps PDFDocumentDelegateHandle.

PdfDocumentInfo

Snapshot of PDFDocument state.

PdfDocumentWriteOptions

Builder-style options for the corresponding PDFDocumentWrite API.

PdfEdgeInsets

Wraps NSEdgeInsets values used by PDFView.

PdfKitError

Wraps PDFKitError.

PdfOutline

Wraps PDFOutline.

PdfPage

Wraps PDFPage.

PdfPageImageInitializationOptions

Builder-style options for the corresponding PDFPageImageInitialization API.

PdfPageOverlayView

Wraps PDFPageOverlayView.

PdfPageOverlayViewProviderHandle

Wraps PDFPageOverlayViewProviderHandle.

PdfPoint

Wraps CGPoint values used by PDFKit geometry APIs.

PdfRect

Wraps CGRect values used by PDFKit geometry APIs.

PdfSelection

Wraps PDFSelection.

PdfSize

Wraps CGSize values used by PDFKit geometry APIs.

PdfTextRange

Wraps text-range values returned by PDFSelection.

PdfThumbnailView

Wraps PDFThumbnailView.

PdfThumbnailViewInfo

Snapshot of PDFThumbnailView state.

PdfView

Wraps PDFView.

PdfViewDelegateHandle

Wraps PDFViewDelegateHandle.

PdfViewInfo

Snapshot of PDFView state.

Enums

DisplayBox

Wraps PDFDisplayBox values.

PdfActionNamedName

Wraps PDFActionNamedName values.

PdfAnnotationHighlightingMode

Wraps PdfAnnotationHighlightingMode values.

PdfAnnotationKey

Wraps PdfAnnotationKey values.

PdfAnnotationLineEndingStyle

Wraps PdfAnnotationLineEndingStyle values.

PdfAnnotationSubtype

Wraps PdfAnnotationSubtype values.

PdfAnnotationTextIconName

Wraps PdfAnnotationTextIconName values.

PdfAnnotationWidgetSubtype

Wraps PdfAnnotationWidgetSubtype values.

PdfBorderStyle

Wraps PDFBorderStyle values.

PdfDisplayDirection

Wraps PDFDisplayDirection values.

PdfDisplayMode

Wraps PDFDisplayMode values.

PdfDocumentNotification

Wraps PDFDocument notification constants.

PdfDocumentNotificationUserInfoKey

Wraps PDFDocument notification user-info key constants.

PdfDocumentPermissions

Wraps PDFDocumentPermissions values.

PdfInterpolationQuality

Wraps PDFInterpolationQuality values.

PdfLineStyle

Wraps PDFLineStyle values.

PdfMarkupType

Wraps PDFMarkupType values.

PdfPrintScalingMode

Wraps PDFPrintScalingMode values.

PdfSelectionGranularity

Wraps PDFSelectionGranularity values.

PdfTextAnnotationIconType

Wraps PDFTextAnnotationIconType values.

PdfThumbnailLayoutMode

Wraps PDFThumbnailLayoutMode values.

PdfThumbnailViewNotification

Wraps PDFThumbnailView notification constants.

PdfViewNotification

Wraps PDFView notification constants.

PdfWidgetCellState

Wraps PDFWidgetCellState values.

PdfWidgetControlType

Wraps PDFWidgetControlType values.

Traits

PdfActionLike

Mirrors the PDFActionLike callback surface.

PdfDocumentDelegate

Mirrors the PDFDocumentDelegate callback surface.

PdfPageOverlayViewProvider

Mirrors the PDFPageOverlayViewProvider callback surface.

PdfViewDelegate

Mirrors the PDFViewDelegate callback surface.

Type Aliases

Result

Result alias used by the PDFKit wrappers.