pdfkit/
action_named.rs

1use std::ptr;
2
3use crate::action::{sealed, PdfActionLike};
4use crate::error::Result;
5use crate::ffi;
6use crate::handle::ObjectHandle;
7use crate::types::PdfActionNamedName;
8use crate::util::take_string;
9
10/// Wraps `PDFActionNamed`.
11#[derive(Debug, Clone)]
12pub struct PdfActionNamed {
13    handle: ObjectHandle,
14}
15
16impl PdfActionNamed {
17    pub(crate) fn from_handle(handle: ObjectHandle) -> Self {
18        Self { handle }
19    }
20
21    /// Wraps `PDFActionNamed(name:)`.
22    pub fn new(name: PdfActionNamedName) -> Result<Self> {
23        let mut out_action = ptr::null_mut();
24        let mut out_error = ptr::null_mut();
25        let status =
26            unsafe { ffi::pdf_action_named_new(name.as_raw(), &mut out_action, &mut out_error) };
27        crate::util::status_result(status, out_error)?;
28        Ok(Self::from_handle(crate::util::required_handle(
29            out_action,
30            "PDFActionNamed",
31        )?))
32    }
33
34    /// Returns the corresponding PDFKit constant name.
35    #[must_use]
36    pub fn name(&self) -> Option<PdfActionNamedName> {
37        PdfActionNamedName::from_raw(unsafe {
38            ffi::pdf_action_named_name_raw(self.handle.as_ptr())
39        })
40    }
41
42    /// Wraps the corresponding `PDFActionNamed` API.
43    pub fn set_name(&self, name: PdfActionNamedName) -> Result<()> {
44        let mut out_error = ptr::null_mut();
45        let status = unsafe {
46            ffi::pdf_action_named_set_name(self.handle.as_ptr(), name.as_raw(), &mut out_error)
47        };
48        crate::util::status_result(status, out_error)
49    }
50
51    /// Wraps the corresponding `PDFActionNamed` API.
52    #[must_use]
53    pub fn action_type(&self) -> Option<String> {
54        take_string(unsafe { ffi::pdf_action_named_type_string(self.handle.as_ptr()) })
55    }
56
57    pub(crate) fn as_handle_ptr(&self) -> *mut core::ffi::c_void {
58        self.handle.as_ptr()
59    }
60}
61
62impl sealed::Sealed for PdfActionNamed {}
63
64impl PdfActionLike for PdfActionNamed {
65    fn as_action_handle_ptr(&self) -> *mut core::ffi::c_void {
66        self.as_handle_ptr()
67    }
68}
pdfkit/action_named.rs

pdfkit/
action_named.rs
