Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub plate: Rect,
    pub alignment: Alignment,
    pub font_size: f32,
    pub multi_line: bool,
    pub auto_return: bool,
    pub sub_word: Option<char>,
    pub limit_char: usize,
    pub char_array: usize,
    pub direction: Direction,
}
Expand description

How a piece of variable text is to be set.

use pdfrum_doc::geom;
use pdfrum_doc::vt::{Config, Metrics, layout};

// Every character ten thousandths wide: the stub the layout assertions
// in this crate are written against.
let width = |_code: u32| 10;
let metrics = Metrics { width: &width, ascent: 1000, descent: -200 };

let config = Config {
    plate: geom::rect(0.0, 0.0, 100.0, 40.0),
    font_size: 10.0,
    multi_line: true,
    ..Config::default()
};
let laid_out = layout("Hi", &config, &metrics);

// A plain config struct with `Default` plus struct-update syntax.
assert_eq!(laid_out.sections.len(), 1);

Fields§

§plate: Rect

The box the text is set into.

§alignment: Alignment

Where lines sit horizontally.

§font_size: f32

The size, or zero to choose one automatically.

§multi_line: bool

Whether the text may occupy more than one line.

§auto_return: bool

Whether a line too long for the plate wraps.

§sub_word: Option<char>

The character every character is displayed as, for a password field. Widths use it too.

§limit_char: usize

A cap on how many characters are set at all.

§char_array: usize

A comb field’s cell count. Non-zero switches to comb layout.

§direction: Direction

The paragraph direction offered to the bidi resolver.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Config

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.