pdfkit-rs 0.2.1

Safe Rust bindings for Apple's PDFKit framework — documents, pages, selections, outlines, annotations, destinations, actions, and view state on macOS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

mod common;

use pdfkit::prelude::*;

#[test]
fn notifications_new_enums_and_write_options_builders_are_exposed() {
    assert_eq!(
        [
            PdfDocumentNotification::DidUnlock.name(),
            PdfDocumentNotification::DidBeginFind.name(),
            PdfDocumentNotification::DidEndFind.name(),
            PdfDocumentNotification::DidBeginPageFind.name(),
            PdfDocumentNotification::DidEndPageFind.name(),
            PdfDocumentNotification::DidFindMatch.name(),
            PdfDocumentNotification::DidBeginWrite.name(),
            PdfDocumentNotification::DidEndWrite.name(),
            PdfDocumentNotification::DidBeginPageWrite.name(),
            PdfDocumentNotification::DidEndPageWrite.name(),
        ],
        [
            "PDFDocumentDidUnlockNotification",
            "PDFDocumentDidBeginFindNotification",
            "PDFDocumentDidEndFindNotification",
            "PDFDocumentDidBeginPageFindNotification",
            "PDFDocumentDidEndPageFindNotification",
            "PDFDocumentDidFindMatchNotification",
            "PDFDocumentDidBeginWriteNotification",
            "PDFDocumentDidEndWriteNotification",
            "PDFDocumentDidBeginPageWriteNotification",
            "PDFDocumentDidEndPageWriteNotification",
        ]
    );
    assert_eq!(
        [
            PdfDocumentNotificationUserInfoKey::FoundSelection.name(),
            PdfDocumentNotificationUserInfoKey::PageIndex.name(),
        ],
        ["PDFDocumentFoundSelection", "PDFDocumentPageIndex"]
    );
    assert_eq!(
        [
            PdfViewNotification::AnnotationHit.name(),
            PdfViewNotification::AnnotationWillHit.name(),
            PdfViewNotification::ChangedHistory.name(),
            PdfViewNotification::CopyPermission.name(),
            PdfViewNotification::DisplayBoxChanged.name(),
            PdfViewNotification::DisplayModeChanged.name(),
            PdfViewNotification::DocumentChanged.name(),
            PdfViewNotification::PageChanged.name(),
            PdfViewNotification::PrintPermission.name(),
            PdfViewNotification::ScaleChanged.name(),
            PdfViewNotification::SelectionChanged.name(),
            PdfViewNotification::VisiblePagesChanged.name(),
        ],
        [
            "PDFViewAnnotationHitNotification",
            "PDFViewAnnotationWillHitNotification",
            "PDFViewChangedHistoryNotification",
            "PDFViewCopyPermissionNotification",
            "PDFViewDisplayBoxChangedNotification",
            "PDFViewDisplayModeChangedNotification",
            "PDFViewDocumentChangedNotification",
            "PDFViewPageChangedNotification",
            "PDFViewPrintPermissionNotification",
            "PDFViewScaleChangedNotification",
            "PDFViewSelectionChangedNotification",
            "PDFViewVisiblePagesChangedNotification",
        ]
    );
    assert_eq!(
        PdfThumbnailViewNotification::DocumentEdited.name(),
        "PDFThumbnailViewDocumentEditedNotification"
    );
    assert_eq!(PdfActionNamedName::from_raw(8), Some(PdfActionNamedName::Find));
    assert_eq!(PdfActionNamedName::ZoomOut.as_raw(), 11);
    assert_eq!(PdfLineStyle::from_raw(4), Some(PdfLineStyle::OpenArrow));
    assert_eq!(PdfMarkupType::from_raw(3), Some(PdfMarkupType::Redact));

    let options = PdfDocumentWriteOptions::default()
        .with_owner_password("owner")
        .with_user_password("user")
        .with_access_permissions(1)
        .with_burn_in_annotations(true)
        .with_save_text_from_ocr(true)
        .with_save_images_as_jpeg(true)
        .with_optimize_images_for_screen(true);
    assert_eq!(options.owner_password.as_deref(), Some("owner"));
    assert_eq!(options.user_password.as_deref(), Some("user"));
    assert_eq!(options.access_permissions, Some(1));
    assert!(options.burn_in_annotations);
    assert!(options.save_text_from_ocr);
    assert!(options.save_images_as_jpeg);
    assert!(options.optimize_images_for_screen);
}

#[test]
fn document_write_options_roundtrip() -> Result<()> {
    let (document, page) = common::empty_document_with_page()?;
    let annotation = common::sample_link_annotation()?;
    page.add_annotation(&annotation)?;
    let output = common::output_path("document-write-options.pdf");
    let options = PdfDocumentWriteOptions::default()
        .with_owner_password("owner")
        .with_user_password("user")
        .with_access_permissions(1);

    document.write_to_url_with_options(&output, &options)?;

    let reopened = PdfDocument::from_url(&output)?;
    let info = reopened.info()?;
    assert!(info.is_encrypted);
    assert!(reopened.unlock("user")? || reopened.unlock("owner")?);
    let unlocked_info = reopened.info()?;
    assert_ne!(unlocked_info.access_permissions & 1, 0);
    Ok(())
}