Struct FieldFlags

pub struct FieldFlags(/* private fields */);

Bitflags describing various characteristics of a form field.

Implementations

impl FieldFlags

pub const READ_ONLY: Self = _

The user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

pub const REQUIRED: Self = _

The field shall have a value at the time it is exported by a submit-formAction.

pub const NO_EXPORT: Self = _

The field shall not be exported by a submit-formAction.

pub const DO_NOT_SPELL_CHECK: Self = _

The entered text shall not be spell-checked, can be used for text and choice fields.

pub const NO_TOGGLE_TO_OFF: Self = _

Exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. If unset, clicking the selected button deselects it, leaving no button selected. Only permissible for radio buttons.

pub const RADIO: Self = _

The field is a set of radio buttons; if clear, the field is a check box. This flag may be set only if the PUSHBUTTON flag is unset.

pub const PUSHBUTTON: Self = _

The field is a push button that does not retain a permanent value.

pub const RADIOS_IN_UNISON: Self = _

A group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If unset, the buttons are mutually exclusive (the same behavior as HTML radio buttons). PDF 1.5+.

pub const MULTILINE: Self = _

The text may contain multiple lines of text, otherwise the text is restricted to one line.

pub const PASSWORD: Self = _

The text contains a password and should not be echoed visibly to the screen.

pub const FILE_SELECT: Self = _

The entered text represents a path to a file who’s contents shall be submitted as the value of the field. PDF 1.4+.

pub const DO_NOT_SCROLL: Self = _

The field shall not scroll horizontally (for single-line) or vertically (for multi-line) to accomodate more text. Once the field is full, no further text shall be accepted for interactive form filling; for non-interactive form filling, the filler should take care not to add more character than will visibly fit in the defined area. PDF 1.4+.

pub const COMB: Self = _

The field shall be automatically divided into as many equally spaced positions or combs as the value of [Field::max_len] and the text is layed out into these combs. May only be set if the [Field::max_len] property is set and if the [MULTILINE], [PASSWORD] and [FILE_SELECT] flags are clear. PDF 1.5+.

pub const RICH_TEXT: Self = _

The value of this field shall be a rich text string. If the field has a value, the [TextField::rich_text_value] shall specify the rich text string. PDF 1.5+.

pub const COMBO: Self = _

The field is a combo box if set, else it’s a list box. A combo box is often referred to as a dropdown menu.

pub const EDIT: Self = _

The combo box shall include an editable text box as well as a drop-down list. Shall only be used if [COMBO] is set.

pub const SORT: Self = _

The field’s option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers.

pub const MULTI_SELECT: Self = _

More than one option of the choice field may be selected simultaneously. PDF 1.4+.

pub const COMMIT_ON_SEL_CHANGE: Self = _

The new value shall be committed as soon as a selection is made (commonly with the mouse). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or “commits” the data choice and triggers any actions associated with the entry or changing of this data.

If set, processing does not wait for leaving the field action to occur, but immediately proceeds to the third step. PDF 1.5+.

impl FieldFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FieldFlags

pub const fn iter(&self) -> Iter<FieldFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<FieldFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for FieldFlags

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

Formats the value using the given formatter.

impl BitAnd for FieldFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = FieldFlags

The resulting type after applying the & operator.

impl BitAndAssign for FieldFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for FieldFlags

fn bitor(self, other: FieldFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = FieldFlags

The resulting type after applying the | operator.

impl BitOrAssign for FieldFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for FieldFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = FieldFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for FieldFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Extend<FieldFlags> for FieldFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for FieldFlags

const FLAGS: &'static [Flag<FieldFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> FieldFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<FieldFlags> for FieldFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for FieldFlags

type Item = FieldFlags

The type of the elements being iterated over.

type IntoIter = Iter<FieldFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for FieldFlags

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

Formats the value using the given formatter.

impl Not for FieldFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = FieldFlags

The resulting type after applying the ! operator.

impl Octal for FieldFlags

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

Formats the value using the given formatter.

impl PublicFlags for FieldFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for FieldFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FieldFlags

The resulting type after applying the - operator.

impl SubAssign for FieldFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FieldFlags

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

Formats the value using the given formatter.