Struct FieldValues 

pub struct FieldValues { /* private fields */ }

Values written to a form’s fields, keyed by fully-qualified name.

The edit buffer, and the reason this crate can fill a form without mutating anything: the parser’s object store is immutable and its objects are values, so a write is recorded here and every reader consults it. It is the same shape as the appearance AnnotOverlay, for the same reason.

Turning the buffer into a file is apply’s job.

Implementations

impl FieldValues

pub fn new() -> FieldValues

An empty buffer.

use pdfrum_doc::form::FieldValues;

assert!(FieldValues::new().is_empty());

pub fn set(&mut self, name: impl Into<String>, value: impl Into<String>)

Records a value for the field with this fully-qualified name, replacing any earlier one.

use pdfrum_doc::form::FieldValues;

let mut values = FieldValues::new();
values.set("name", "Ada");
// Writing again replaces, it does not append.
values.set("name", "Grace");
assert_eq!(values.get("name"), Some("Grace"));
assert_eq!(values.len(), 1);

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

What was written for this field, if anything.

use pdfrum_doc::form::FieldValues;

let mut values = FieldValues::new();
values.set("name", "Ada");
assert_eq!(values.get("name"), Some("Ada"));
assert_eq!(values.get("absent"), None);

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Every recorded write, in the order it was first made.

use pdfrum_doc::form::FieldValues;

let mut values = FieldValues::new();
values.set("b", "2");
values.set("a", "1");
// First-write order, not sorted.
assert_eq!(values.iter().collect::<Vec<_>>(), [("b", "2"), ("a", "1")]);

pub fn len(&self) -> usize

How many fields have been written to.

use pdfrum_doc::form::FieldValues;

let mut values = FieldValues::new();
values.set("name", "Ada");
assert_eq!(values.len(), 1);

pub fn is_empty(&self) -> bool

Whether nothing has been written.

use pdfrum_doc::form::FieldValues;

let mut values = FieldValues::new();
values.set("name", "Ada");
assert!(!values.is_empty());

Trait Implementations

impl Clone for FieldValues

fn clone(&self) -> FieldValues

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldValues

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

Formats the value using the given formatter.

impl Default for FieldValues

fn default() -> FieldValues

Returns the “default value” for a type.

impl Eq for FieldValues

impl PartialEq for FieldValues

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FieldValues