Struct TextConfig 

pub struct TextConfig {
    pub multi_line: bool,
    pub password: bool,
    pub comb: bool,
    pub max_len: Option<NonZeroU32>,
    pub read_only: bool,
    pub undo_enabled: bool,
    pub auto_scroll: bool,
}

How a field’s text is set, read once from its flags and entries.

The layout half of these switches is already the variable-text engine’s business; what this record adds is the editor’s own — whether the field accepts edits at all, whether it records undo, and whether it scrolls.

The booleans are the point rather than a smell: each one is a distinct /Ff bit with its own meaning, and the alternative the lint suggests — a packed flag word — is exactly the design this record exists to replace, where the same bit means different things to different field kinds.

use pdfrum_form::TextConfig;

// The default record is the plain single-line field with no length limit;
// a real field's switches come from [`TextConfig::read`].
let config = TextConfig::default();
assert!(!config.multi_line);
assert_eq!(config.max_len, None);

Fields

multi_line: bool

Whether the field accepts more than one line.

password: bool

Whether the field’s contents are obscured as they are typed.

comb: bool

Whether the field is laid out as a row of equal cells.

max_len: Option<NonZeroU32>

The cap on how many characters the field holds, if it has one.

An Option rather than a sentinel, which is how “a non-positive limit means unlimited” stops being a rule anyone has to remember.

read_only: bool

Whether the field refuses edits.

undo_enabled: bool

Whether the field records undo. Always true for a text field.

auto_scroll: bool

Whether the field scrolls its content to follow the caret.

Implementations

impl TextConfig

pub fn read(flags: FieldFlags, max_len: Option<u32>) -> TextConfig

Reads a text field’s configuration from its flags and length limit.

The scrolling rule is the one worth reading twice: a field scrolls unless it is explicitly told not to, and that is true whether or not it is multiline — the two cases differ in what else they turn on, not in whether they scroll.

use pdfrum_doc::form::FieldFlags;
use pdfrum_form::TextConfig;

// Multiline (`/Ff` bit 13) still scrolls, and a zero `/MaxLen` is no
// limit rather than a limit of nothing.
let config = TextConfig::read(FieldFlags::from_bits(1 << 12), Some(0));
assert!(config.multi_line);
assert!(config.auto_scroll);
assert_eq!(config.max_len, None);
assert!(config.undo_enabled, "undo is on for every text field");

// Only the do-not-scroll bit (24) turns scrolling off.
assert!(!TextConfig::read(FieldFlags::from_bits(1 << 23), None).auto_scroll);

Trait Implementations

impl Clone for TextConfig

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 TextConfig

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

Formats the value using the given formatter.

impl Default for TextConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TextConfig

impl PartialEq for TextConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextConfig