Skip to main content

pdfkit/
lib.rs

1#![doc = include_str!("../README.md")]
2//!
3//! ---
4//!
5//! # API Documentation
6//!
7//! Safe Rust bindings for Apple's [PDFKit](https://developer.apple.com/documentation/pdfkit)
8//! framework on macOS.
9
10#![cfg_attr(docsrs, feature(doc_cfg))]
11#![allow(
12    clippy::cast_possible_truncation,
13    clippy::doc_markdown,
14    clippy::missing_const_for_fn,
15    clippy::missing_errors_doc,
16    clippy::module_name_repetitions,
17    clippy::must_use_candidate,
18    clippy::redundant_pub_crate,
19    clippy::return_self_not_must_use,
20    clippy::struct_excessive_bools
21)]
22
23mod accessibility_node;
24mod action;
25mod action_goto;
26mod action_named;
27mod action_remote_goto;
28mod action_url;
29mod annotation;
30mod appearance_characteristics;
31mod border;
32mod destination;
33mod document;
34mod document_delegate;
35mod error;
36mod ffi;
37mod handle;
38mod notifications;
39mod outline;
40mod page;
41mod selection;
42mod thumbnail_view;
43mod types;
44mod util;
45mod view;
46
47pub use accessibility_node::PdfAccessibilityNode;
48pub use action::{PdfAction, PdfActionLike};
49pub use action_goto::PdfActionGoTo;
50pub use action_named::PdfActionNamed;
51pub use action_remote_goto::PdfActionRemoteGoTo;
52pub use action_url::PdfActionUrl;
53pub use annotation::PdfAnnotation;
54pub use appearance_characteristics::PdfAppearanceCharacteristics;
55pub use border::PdfBorder;
56pub use destination::PdfDestination;
57pub use document::PdfDocument;
58pub use document_delegate::{PdfDocumentDelegate, PdfDocumentDelegateHandle};
59pub use error::{PdfKitError, Result};
60pub use notifications::{
61    PdfDocumentNotification, PdfDocumentNotificationUserInfoKey, PdfThumbnailViewNotification,
62    PdfViewNotification,
63};
64pub use outline::PdfOutline;
65pub use page::PdfPage;
66pub use selection::PdfSelection;
67pub use thumbnail_view::PdfThumbnailView;
68pub use types::{
69    DisplayBox, PdfActionNamedName, PdfAnnotationInfo, PdfAppearanceCharacteristicsInfo,
70    PdfBorderInfo, PdfBorderStyle, PdfColor, PdfDestinationInfo, PdfDisplayDirection,
71    PdfDisplayMode, PdfDocumentAttributes, PdfDocumentInfo, PdfDocumentPermissions,
72    PdfDocumentWriteOptions, PdfEdgeInsets, PdfInterpolationQuality, PdfLineStyle,
73    PdfMarkupType, PdfPoint, PdfRect, PdfSize, PdfTextRange, PdfThumbnailViewInfo,
74    PdfViewInfo, PdfWidgetControlType,
75};
76pub use view::PdfView;
77
78pub mod prelude {
79    pub use crate::{
80        DisplayBox, PdfAccessibilityNode, PdfAction, PdfActionGoTo, PdfActionNamed,
81        PdfActionNamedName, PdfActionRemoteGoTo, PdfActionUrl, PdfAnnotation,
82        PdfAnnotationInfo, PdfAppearanceCharacteristics, PdfAppearanceCharacteristicsInfo,
83        PdfBorder, PdfBorderInfo, PdfBorderStyle, PdfColor, PdfDestination,
84        PdfDestinationInfo, PdfDisplayDirection, PdfDisplayMode, PdfDocument,
85        PdfDocumentAttributes, PdfDocumentDelegate, PdfDocumentDelegateHandle,
86        PdfDocumentInfo, PdfDocumentNotification, PdfDocumentNotificationUserInfoKey,
87        PdfDocumentPermissions, PdfDocumentWriteOptions, PdfEdgeInsets,
88        PdfInterpolationQuality, PdfKitError, PdfLineStyle, PdfMarkupType, PdfOutline,
89        PdfPage, PdfPoint, PdfRect, PdfSelection, PdfSize, PdfTextRange,
90        PdfThumbnailView, PdfThumbnailViewInfo, PdfThumbnailViewNotification, PdfView,
91        PdfViewInfo, PdfViewNotification, PdfWidgetControlType, Result,
92    };
93}