Struct Place 

pub struct Place {
    pub section: u32,
    pub line: u32,
    pub word: Option<u32>,
}

A caret position: after character word of line line of section section.

word == None is the line header — the position before the line’s first character. Every other value names the character the caret sits after.

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);
use pdfrum_doc::vt::hit;
use pdfrum_doc::vt::hit::Place;

// The header -- the position before a line's first character --
// orders ahead of every character on it.
assert!(Place::new(0, 0, None) < Place::new(0, 0, Some(0)));

Fields

section: u32

Which paragraph.

line: u32

Which line of that paragraph.

word: Option<u32>

The character the caret follows, or None for the line header.

None orders before every Some, so the header sorts ahead of the line’s characters.

Implementations

impl Place

pub const START: Place

The place every layout begins at: the header of its first line.

A constant rather than a query, because it does not depend on the layout — the first caret position is the first line’s header whatever the text is, including no text at all. begin_place is the same value, spelled for symmetry with end_place, which does need the layout.

The header is None, not a sentinel index.

use pdfrum_doc::vt::hit::Place;

// The beginning of the text, not `(0, 0, 0)`: a zero `word` is the
// position *after* the first character.
assert_eq!(Place::START, Place::new(0, 0, None));
assert_eq!(Place::default(), Place::START);

pub fn new(section: u32, line: u32, word: Option<u32>) -> Place

A place, from the three indices.

use pdfrum_doc::vt::hit::Place;

let after_first = Place::new(0, 0, Some(0));
assert_eq!(after_first.word, Some(0));

pub fn start() -> Place

Place::START, as a function.

use pdfrum_doc::vt::hit::Place;

assert_eq!(Place::start(), Place::START);

Trait Implementations

impl Clone for Place

fn clone(&self) -> Place

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Place

impl Debug for Place

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

Formats the value using the given formatter.

impl Default for Place

The beginning of the text, not (0, 0, 0).

#[derive(Default)] would zero all three fields, and a zero word is the position after the first character — a different, valid-looking caret that no layout ever means by “the default”. The beginning of the text is section 0, line 0, and no word, which is what a caller reaching for a default wants.

fn default() -> Place

Returns the “default value” for a type.

impl Eq for Place

impl Hash for Place

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Place

fn cmp(&self, other: &Place) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Place

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Place

fn partial_cmp(&self, other: &Place) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PlaceExt for Place

fn start() -> Place

The first place of any layout: the header of its first line.

fn at_line_start(self) -> bool

Whether this place sits before its line’s first character.

fn same_line(self, other: Place) -> bool

Whether two places are on the same line, ignoring the character.

impl StructuralPartialEq for Place