Struct DocumentModel 

pub struct DocumentModel {
    pub page_count: u32,
    pub path: String,
    pub url: String,
    pub page_words: Vec<Vec<String>>,
    pub info: Vec<(String, String)>,
    pub has_info: bool,
    pub fields: Vec<FieldModel>,
    pub named_destinations: Vec<(String, u32)>,
    pub annotations: Vec<AnnotModel>,
    pub calculate: bool,
}

Available on crate feature javascript only.

Everything the Doc object answers from.

Every field has a defined answer when the caller says nothing, and that answer is the oracle’s for a document with no /Info, no /Fields and no path: empty strings, zero counts, and a page count of zero.

Fields

page_count: u32

Doc.numPages. The page count as the viewer knows it.

path: String

Doc.path — the system path, with the oracle’s leading separator.

A leading / is prefixed when there is not one already, which is why path reads /myfile.pdf where URL reads a bare myfile.pdf.

url: String

Doc.URL — the same path, unprefixed. JS_docGetFilePath().

page_words: Vec<Vec<String>>

The words each page draws, in content order.

Installed by the caller, like everything else here: counting them needs a parsed content stream, which this model deliberately does not hold. pdfrum_text::content_words is the reader for a pdfrum page, and an empty list is the honest answer for a caller that did not supply one — getPageNumWords then answers 0, which is what an empty page gives.

info: Vec<(String, String)>

The /Info entries, in the order the dictionary writes them.

A Vec rather than a map because Doc.info enumerates the whole dictionary after its nine fixed keys, in the file’s own order, and a sorted map would reorder what a golden pins.

has_info: bool

Whether the document has an /Info dictionary at all.

The distinction is load-bearing and is not “is info empty”: with no /Info at all, every metadata getter and Doc.info itself throw Object no longer exists., where an /Info present but empty answers "" for each. GetPropertyInternal returns kBadObjectError the moment GetInfoDict() is null.

fields: Vec<FieldModel>

Every terminal field, in /AcroForm /Fields order.

The list Doc.numFields counts and Doc.getNthFieldName(n) indexes, and the space FieldRef::index names.

named_destinations: Vec<(String, u32)>

The named destinations Doc.gotoNamedDest can reach, and the page each lands on.

annotations: Vec<AnnotModel>

Every annotation Doc.getAnnot and Doc.getAnnots can see, by page.

Pop-ups and widgets are already excluded: getAnnots skips both subtypes, so a caller that includes them would make bug_421304870’s count wrong. Filtering here rather than in the binding keeps the rule beside the /Annots walk that can see the subtypes.

calculate: bool

Doc.calculate — whether a recalculation sweep runs at all.

true is the oracle’s initial state (CPDFSDK_InteractiveForm’s calculate_ defaults on), and a script may turn it off.

Implementations

impl DocumentModel

pub fn empty() -> DocumentModel

The model for a document with nothing in it — no pages, no fields, no /Info.

Not Default, because calculate defaults on upstream and a derived Default would say otherwise. Every other field’s zero value is already the right answer.

pub fn field_at(&self, index: usize) -> Option<&FieldModel>

The field at a /Fields position.

pub fn fields_named<'a>( &'a self, name: &str, ) -> impl Iterator<Item = &'a FieldModel> + 'a

Every terminal field a name reaches, in /Fields order.

CountFields(name) is this list’s length and GetField(j, name) is its jth entry, so a name that is a whole subtree answers every leaf under it rather than one — which is what makes AFSimple_Calculate('SUM', ['Group']) add a group’s fields.

pub fn field_named(&self, name: &str) -> Option<usize>

The position of the field Doc.getField(name) resolves to.

A name may be a whole subtree, and it answers the first leaf under it

The field tree has a node per name segment, not per terminal field. So a name that only names structure — one whose kids each carry their own /T — is still a node, and the answer is the first terminal field beneath it.

The object’s .name still reads the name the caller asked for rather than the field’s own, which is why the Field object carries the lookup name on the object.

A prefix that is not a whole segment matches nothing: MyFie is not a node.

pub fn count_fields(&self, name: &str) -> usize

How many terminal fields sit under the node a name reaches.

Zero means Doc.getField answers undefined.

Trait Implementations

impl Clone for DocumentModel

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentModel

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

Formats the value using the given formatter.

impl Default for DocumentModel

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for DocumentModel

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentModel