pdfkit-rs 0.2.4

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

use std::ptr;

use crate::action::{sealed, PdfActionLike};
use crate::error::{PdfKitError, Result};
use crate::ffi;
use crate::handle::ObjectHandle;
use crate::util::{c_string, parse_json, take_string};

/// Wraps `PDFActionResetForm`.
#[derive(Debug, Clone)]
pub struct PdfActionResetForm {
    handle: ObjectHandle,
}

impl PdfActionResetForm {
    pub(crate) fn from_handle(handle: ObjectHandle) -> Self {
        Self { handle }
    }

    /// Wraps `PDFActionResetForm()`.
    pub fn new() -> Result<Self> {
        let mut out_action = ptr::null_mut();
        let mut out_error = ptr::null_mut();
        let status = unsafe { ffi::pdf_action_reset_form_new(&mut out_action, &mut out_error) };
        crate::util::status_result(status, out_error)?;
        Ok(Self::from_handle(crate::util::required_handle(
            out_action,
            "PDFActionResetForm",
        )?))
    }

    /// Wraps the corresponding `PDFActionResetForm` API.
    pub fn fields(&self) -> Result<Vec<String>> {
        parse_json(
            unsafe { ffi::pdf_action_reset_form_fields_json(self.handle.as_ptr()) },
            "PDFActionResetForm fields",
        )
    }

    /// Wraps the corresponding `PDFActionResetForm` API.
    pub fn set_fields<I, S>(&self, fields: I) -> Result<()>
    where
        I: IntoIterator<Item = S>,
        S: AsRef<str>,
    {
        let fields = fields
            .into_iter()
            .map(|field| field.as_ref().to_string())
            .collect::<Vec<_>>();
        let fields_json = serde_json::to_string(&fields).map_err(|error| {
            PdfKitError::new(
                ffi::status::FRAMEWORK,
                format!("failed to encode PDFActionResetForm fields: {error}"),
            )
        })?;
        let fields_json = c_string(&fields_json)?;
        let mut out_error = ptr::null_mut();
        let status = unsafe {
            ffi::pdf_action_reset_form_set_fields_json(
                self.handle.as_ptr(),
                fields_json.as_ptr(),
                &mut out_error,
            )
        };
        crate::util::status_result(status, out_error)
    }

    /// Wraps the corresponding `PDFActionResetForm` API.
    pub fn clear_fields(&self) -> Result<()> {
        let mut out_error = ptr::null_mut();
        let status = unsafe {
            ffi::pdf_action_reset_form_set_fields_json(
                self.handle.as_ptr(),
                ptr::null(),
                &mut out_error,
            )
        };
        crate::util::status_result(status, out_error)
    }

    /// Wraps the corresponding `PDFActionResetForm` API.
    #[must_use]
    pub fn fields_included_are_cleared(&self) -> bool {
        unsafe { ffi::pdf_action_reset_form_fields_included_are_cleared(self.handle.as_ptr()) != 0 }
    }

    /// Wraps the corresponding `PDFActionResetForm` API.
    pub fn set_fields_included_are_cleared(&self, value: bool) {
        unsafe {
            ffi::pdf_action_reset_form_set_fields_included_are_cleared(
                self.handle.as_ptr(),
                i32::from(value),
            );
        }
    }

    /// Wraps the corresponding `PDFActionResetForm` API.
    #[must_use]
    pub fn action_type(&self) -> Option<String> {
        take_string(unsafe { ffi::pdf_action_reset_form_type_string(self.handle.as_ptr()) })
    }

    pub(crate) fn as_handle_ptr(&self) -> *mut core::ffi::c_void {
        self.handle.as_ptr()
    }
}

impl sealed::Sealed for PdfActionResetForm {}

impl PdfActionLike for PdfActionResetForm {
    fn as_action_handle_ptr(&self) -> *mut core::ffi::c_void {
        self.as_handle_ptr()
    }
}