Struct poppler::Document

pub struct Document { /* private fields */ }

Properties

author

The author of the document

Readable | Writeable

creation-date

The date the document was created as seconds since the Epoch, or -1

Readable | Writeable

creation-datetime

The [glib::DateTime][crate::glib::DateTime] the document was created.

Readable | Writeable

creator

The creator of the document. See also Document::creator()

Readable | Writeable

format

The PDF version as string. See also Document::pdf_version_string()

Readable

format-major

The PDF major version number. See also Document::pdf_version()

Readable

format-minor

The PDF minor version number. See also Document::pdf_version()

Readable

keywords

The keywords associated to the document

Readable | Writeable

linearized

Whether document is linearized. See also Document::is_linearized()

Readable

metadata

Document metadata in XML format, or None

Readable

mod-date

The date the document was most recently modified as seconds since the Epoch, or -1

Readable | Writeable

mod-datetime

The [glib::DateTime][crate::glib::DateTime] the document was most recently modified.

Readable | Writeable

page-layout

The page layout that should be used when the document is opened

Readable

page-mode

The mode that should be used when the document is opened

Readable

permissions

Flags specifying which operations are permitted when the document is opened

Readable

print-duplex

Readable

print-n-copies

Suggested number of copies to be printed for this document

Readable

print-scaling

Readable

producer

The producer of the document. See also Document::producer()

Readable | Writeable

subject

The subject of the document

Readable | Writeable

subtype

Document PDF subtype type

Readable

subtype-conformance

Document PDF subtype conformance

Readable

subtype-part

Document PDF subtype part

Readable

subtype-string

Document PDF subtype. See also Document::pdf_subtype_string()

Readable

title

The document’s title or None

Readable | Writeable

viewer-preferences

Readable

GLib type: GObject with reference counted clone semantics.

Implementations

impl Document

pub fn from_bytes( bytes: &Bytes, password: Option<&str>, ) -> Result<Document, Error>

Available on crate feature v0_82 only.

Creates a new Document from bytes. The returned document will hold a reference to bytes.

On error, None is returned, with error set. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR domains.

bytes

a [glib::Bytes][crate::glib::Bytes]

password

password to unlock the file with, or None

Returns

a newly created Document, or None

pub fn from_data(data: &[u8], password: Option<&str>) -> Result<Document, Error>

👎Deprecated: Since 0.82

Creates a new Document. If None is returned, then error will be set. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR domains.

Note that data is not copied nor is a new reference to it created. It must remain valid and cannot be destroyed as long as the returned document exists.

Deprecated since 0.82

This requires directly managing length and data. Use from_bytes() instead.

data

the pdf data

password

password to unlock the file with, or None

Returns

A newly created Document, or None

pub fn from_fd(fd: i32, password: Option<&str>) -> Result<Document, Error>

Available on crate feature v21_12 only.

Creates a new Document reading the PDF contents from the file descriptor fd. fd must refer to a regular file, or STDIN, and be open for reading. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR domains. Note that this function takes ownership of fd; you must not operate on it again, nor close it.

fd

a valid file descriptor

password

password to unlock the file with, or None

Returns

a new Document, or None

pub fn from_file(uri: &str, password: Option<&str>) -> Result<Document, Error>

Creates a new Document. If None is returned, then error will be set. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR domains.

uri

uri of the file to load

password

password to unlock the file with, or None

Returns

A newly created Document, or None

pub fn from_gfile( file: &impl IsA<File>, password: Option<&str>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Document, Error>

Creates a new Document reading the PDF contents from file. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR domains.

file

a [gio::File][crate::gio::File] to load

password

password to unlock the file with, or None

cancellable

a [gio::Cancellable][crate::gio::Cancellable], or None

Returns

a new Document, or None

pub fn from_stream( stream: &impl IsA<InputStream>, length: i64, password: Option<&str>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Document, Error>

Creates a new Document reading the PDF contents from stream. Note that the given [gio::InputStream][crate::gio::InputStream] must be seekable or G_IO_ERROR_NOT_SUPPORTED will be returned. Possible errors include those in the POPPLER_ERROR, G_FILE_ERROR and G_IO_ERROR domains.

stream

a [gio::InputStream][crate::gio::InputStream] to read from

length

the stream length, or -1 if not known

password

password to unlock the file with, or None

cancellable

a [gio::Cancellable][crate::gio::Cancellable], or None

Returns

a new Document, or None

pub fn builder() -> DocumentBuilder

Creates a new builder-pattern struct instance to construct Document objects.

This method returns an instance of DocumentBuilder which can be used to create Document objects.

pub fn find_dest(&self, link_name: &str) -> Option<Dest>

Creates a Dest for the named destination link_name in self.

Note that named destinations are bytestrings, not string. That means that unless link_name was returned by a poppler function (e.g. is PopplerDest.named_dest), it needs to be converted to string using named_dest_from_bytestring() before being passed to this function.

The returned value must be freed with poppler_dest_free().

link_name

a named destination

Returns

a new Dest destination, or None if link_name is not a destination.

pub fn attachments(&self) -> Vec<Attachment>

Returns a GList containing Attachments. These attachments are unowned, and must be unreffed, and the list must be freed with g_list_free().

Returns

a list of available attachments.

pub fn author(&self) -> Option<GString>

Returns the author of the document

Returns

a new allocated string containing the author of self, or None

pub fn creation_date(&self) -> c_long

Returns the date the document was created as seconds since the Epoch

Returns

the date the document was created, or -1

pub fn creation_date_time(&self) -> Option<DateTime>

Available on crate feature v20_9 only.

Returns the date the document was created as a [glib::DateTime][crate::glib::DateTime]

Returns

the date the document was created, or None

pub fn creator(&self) -> Option<GString>

Returns the creator of the document. If the document was converted from another format, the creator is the name of the product that created the original document from which it was converted.

Returns

a new allocated string containing the creator of self, or None

pub fn form_field(&self, id: i32) -> Option<FormField>

Returns the FormField for the given id. It must be freed with g_object_unref()

id

an id of a FormField

Returns

a new FormField or None if not found

pub fn id(&self) -> Option<(GString, GString)>

Returns the PDF file identifier represented as two byte string arrays of size 32. permanent_id is the permanent identifier that is built based on the file contents at the time it was originally created, so that this identifer never changes. update_id is the update identifier that is built based on the file contents at the time it was last updated.

Note that returned strings are not null-terminated, they have a fixed size of 32 bytes.

Returns

true if the self contains an id, false otherwise

permanent_id

location to store an allocated string, use g_free() to free the returned string

update_id

location to store an allocated string, use g_free() to free the returned string

pub fn keywords(&self) -> Option<GString>

Returns the keywords associated to the document

Returns

a new allocated string containing keywords associated to self, or None

pub fn metadata(&self) -> Option<GString>

Returns the XML metadata string of the document

Returns

a new allocated string containing the XML metadata, or None

pub fn modification_date(&self) -> c_long

Returns the date the document was most recently modified as seconds since the Epoch

Returns

the date the document was most recently modified, or -1

pub fn modification_date_time(&self) -> Option<DateTime>

Available on crate feature v20_9 only.

Returns the date the document was most recently modified as a [glib::DateTime][crate::glib::DateTime]

Returns

the date the document was modified, or None

pub fn n_attachments(&self) -> u32

Returns the number of attachments in a loaded document. See also attachments()

Returns

Number of attachments

pub fn n_pages(&self) -> i32

Returns the number of pages in a loaded document.

Returns

Number of pages

pub fn n_signatures(&self) -> i32

Available on crate feature v21_12 only.

Returns how many digital signatures self contains. PDF digital signatures ensure that the content hash not been altered since last edit and that it was produced by someone the user can trust

Returns

The number of signatures found in the document

pub fn page(&self, index: i32) -> Option<Page>

Returns the Page indexed at index. This object is owned by the caller.

index

a page index

Returns

The Page at index

pub fn page_by_label(&self, label: &str) -> Option<Page>

Returns the Page reference by label. This object is owned by the caller. label is a human-readable string representation of the page number, and can be document specific. Typically, it is a value such as “iii” or “3”.

By default, “1” refers to the first page.

label

a page label

Returns

The Page referenced by label

pub fn page_layout(&self) -> PageLayout

Returns the page layout that should be used when the document is opened

Returns

a PageLayout that should be used when the document is opened

pub fn page_mode(&self) -> PageMode

Returns a PageMode representing how the document should be initially displayed when opened.

Returns

a PageMode that should be used when document is opened

pub fn pdf_conformance(&self) -> PDFConformance

Returns the conformance level of the self as PDFConformance.

Returns

the document’s subtype conformance level

pub fn pdf_part(&self) -> PDFPart

Returns the part of the conforming standard that the self adheres to as a PDFSubtype.

Returns

the document’s subtype part

pub fn pdf_subtype(&self) -> PDFSubtype

Returns the subtype of self as a PDFSubtype.

Returns

the document’s subtype

pub fn pdf_subtype_string(&self) -> Option<GString>

Returns the PDF subtype version of self as a string.

Returns

a newly allocated string containing the PDF subtype version of self, or None

pub fn pdf_version(&self) -> (u32, u32)

Updates values referenced by major_version & minor_version with the major and minor PDF versions of self.

Returns

major_version

return location for the PDF major version number

minor_version

return location for the PDF minor version number

pub fn pdf_version_string(&self) -> Option<GString>

Returns the PDF version of self as a string (e.g. PDF-1.6)

Returns

a new allocated string containing the PDF version of self, or None

pub fn permissions(&self) -> Permissions

Returns the flags specifying which operations are permitted when the document is opened.

Returns

a set of flags from Permissions enumeration

pub fn print_duplex(&self) -> PrintDuplex

Available on crate feature v0_80 only.

Returns the duplex mode value suggested for printing by author of the document. Value POPPLER_PRINT_DUPLEX_NONE means that the document does not specify this preference.

Returns

a PrintDuplex that should be used when document is printed

pub fn print_n_copies(&self) -> i32

Available on crate feature v0_80 only.

Returns the suggested number of copies to be printed. This preference should be applied only if returned value is greater than 1 since value 1 usually means that the document does not specify it.

Returns

Number of copies

pub fn print_scaling(&self) -> PrintScaling

Available on crate feature v0_73 only.

Returns the print scaling value suggested by author of the document.

Returns

a PrintScaling that should be used when document is printed

pub fn producer(&self) -> Option<GString>

Returns the producer of the document. If the document was converted from another format, the producer is the name of the product that converted it to PDF

Returns

a new allocated string containing the producer of self, or None

pub fn signature_fields(&self) -> Vec<FormField>

Available on crate feature v22_2 only.

Returns a GList containing all signature FormFields in the document.

Returns

a list of all signature form fields.

pub fn subject(&self) -> Option<GString>

Returns the subject of the document

Returns

a new allocated string containing the subject of self, or None

pub fn title(&self) -> Option<GString>

Returns the document’s title

Returns

a new allocated string containing the title of self, or None

pub fn has_attachments(&self) -> bool

Returns true of self has any attachments.

Returns

true, if self has attachments.

pub fn has_javascript(&self) -> bool

Available on crate feature v0_90 only.

Returns whether self has any javascript in it.

pub fn is_linearized(&self) -> bool

Returns whether self is linearized or not. Linearization of PDF enables efficient incremental access of the PDF file in a network environment.

Returns

true if self is linearized, false otherwise

pub fn reset_form(&self, fields: &[&str], exclude_fields: bool)

Available on crate feature v0_90 only.

Resets the form fields specified by fields if exclude_fields is FALSE. Resets all others if exclude_fields is TRUE. All form fields are reset regardless of the exclude_fields flag if fields is empty.

fields

list of fields to reset

exclude_fields

whether to reset all fields except those in fields

pub fn save(&self, uri: &str) -> Result<(), Error>

Saves self. Any change made in the document such as form fields filled, annotations added or modified will be saved. If error is set, false will be returned. Possible errors include those in the G_FILE_ERROR domain.

uri

uri of file to save

Returns

true, if the document was successfully saved

pub fn save_a_copy(&self, uri: &str) -> Result<(), Error>

pub fn save_to_fd(&self, fd: i32, include_changes: bool) -> Result<(), Error>

Available on crate feature v21_12 only.

Saves self. Any change made in the document such as form fields filled, annotations added or modified will be saved if include_changes is true, or discarded i include_changes is false.

Note that this function takes ownership of fd; you must not operate on it again, nor close it.

If error is set, false will be returned. Possible errors include those in the G_FILE_ERROR domain.

fd

a valid file descriptor open for writing

include_changes

whether to include user changes (e.g. form fills)

Returns

true, if the document was successfully saved

pub fn set_author(&self, author: &str)

Sets the document’s author. If author is None, Author entry is removed from the document’s Info dictionary.

author

A new author

pub fn set_creation_date(&self, creation_date: c_long)

Sets the document’s creation date. If creation_date is -1, CreationDate entry is removed from the document’s Info dictionary.

creation_date

A new creation date

pub fn set_creation_date_time(&self, creation_datetime: Option<&DateTime>)

Available on crate feature v20_9 only.

Sets the document’s creation date. If creation_datetime is None, CreationDate entry is removed from the document’s Info dictionary.

creation_datetime

A new creation [glib::DateTime][crate::glib::DateTime]

pub fn set_creator(&self, creator: &str)

Sets the document’s creator. If creator is None, Creator entry is removed from the document’s Info dictionary.

creator

A new creator

pub fn set_keywords(&self, keywords: &str)

Sets the document’s keywords. If keywords is None, Keywords entry is removed from the document’s Info dictionary.

keywords

New keywords

pub fn set_modification_date(&self, modification_date: c_long)

Sets the document’s modification date. If modification_date is -1, ModDate entry is removed from the document’s Info dictionary.

modification_date

A new modification date

pub fn set_modification_date_time( &self, modification_datetime: Option<&DateTime>, )

Available on crate feature v20_9 only.

Sets the document’s modification date. If modification_datetime is None, ModDate entry is removed from the document’s Info dictionary.

modification_datetime

A new modification [glib::DateTime][crate::glib::DateTime]

pub fn set_producer(&self, producer: &str)

Sets the document’s producer. If producer is None, Producer entry is removed from the document’s Info dictionary.

producer

A new producer

pub fn set_subject(&self, subject: &str)

Sets the document’s subject. If subject is None, Subject entry is removed from the document’s Info dictionary.

subject

A new subject

pub fn set_title(&self, title: &str)

Sets the document’s title. If title is None, Title entry is removed from the document’s Info dictionary.

title

A new title

pub fn sign<P: FnOnce(Result<(), Error>) + 'static>( &self, signing_data: &SigningData, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Available on crate feature v23_7 only.

Sign document using signing_data.

signing_data

a SigningData

cancellable

a [gio::Cancellable][crate::gio::Cancellable]

callback

a GAsyncReadyCallback

pub fn sign_future( &self, signing_data: &SigningData, ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

Available on crate feature v23_7 only.

pub fn creation_datetime(&self) -> Option<DateTime>

Available on crate feature v20_9 only.

The [glib::DateTime][crate::glib::DateTime] the document was created.

pub fn set_creation_datetime(&self, creation_datetime: Option<&DateTime>)

Available on crate feature v20_9 only.

The [glib::DateTime][crate::glib::DateTime] the document was created.

pub fn format(&self) -> Option<GString>

The PDF version as string. See also pdf_version_string()

pub fn format_major(&self) -> u32

The PDF major version number. See also pdf_version()

pub fn format_minor(&self) -> u32

The PDF minor version number. See also pdf_version()

pub fn mod_date(&self) -> i32

👎Deprecated: Since 20.9

The date the document was most recently modified as seconds since the Epoch, or -1

Deprecated since 20.9

This will overflow in 2038. Use mod-datetime instead.

pub fn set_mod_date(&self, mod_date: i32)

👎Deprecated: Since 20.9

The date the document was most recently modified as seconds since the Epoch, or -1

Deprecated since 20.9

This will overflow in 2038. Use mod-datetime instead.

pub fn mod_datetime(&self) -> Option<DateTime>

Available on crate feature v20_9 only.

The [glib::DateTime][crate::glib::DateTime] the document was most recently modified.

pub fn set_mod_datetime(&self, mod_datetime: Option<&DateTime>)

Available on crate feature v20_9 only.

The [glib::DateTime][crate::glib::DateTime] the document was most recently modified.

pub fn subtype(&self) -> PDFSubtype

Document PDF subtype type

pub fn subtype_conformance(&self) -> PDFConformance

Document PDF subtype conformance

pub fn subtype_part(&self) -> PDFPart

Document PDF subtype part

pub fn subtype_string(&self) -> Option<GString>

Document PDF subtype. See also pdf_subtype_string()

pub fn viewer_preferences(&self) -> ViewerPreferences

pub fn connect_author_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_creation_date_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated: Since 20.9

pub fn connect_creation_datetime_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v20_9 only.

pub fn connect_creator_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_format_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_format_major_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_format_minor_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_keywords_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_linearized_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_metadata_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_mod_date_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

👎Deprecated: Since 20.9

pub fn connect_mod_datetime_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v20_9 only.

pub fn connect_page_layout_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_page_mode_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_permissions_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_print_duplex_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v0_80 only.

pub fn connect_print_n_copies_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v0_80 only.

pub fn connect_print_scaling_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v0_73 only.

pub fn connect_producer_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_subject_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_subtype_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_subtype_conformance_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_subtype_part_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_subtype_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_title_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_viewer_preferences_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

impl Document

pub fn print_page_ranges(&self) -> &[PageRange]

Available on crate feature v0_80 only.

Returns the suggested page ranges to print in the form of array of PageRanges and number of ranges. None pointer means that the document does not specify page ranges for printing.

Returns

an array of PageRanges or None. Free the array when it is no longer needed.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Document

type ParamSpec = ParamSpecObject

type SetValue = Document

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Document>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Document

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Document

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Document

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Document

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Document

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Document

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Document