Struct PageBoundarySignature 

pub struct PageBoundarySignature(ContentHash);

A compact, deterministic digest of one laid-out Page’s break-defining content (design note §4.5).

Equal for identical pagination of identical content, different when a page’s content or its break changes. It is the cache slot’s staleness check, not a human-readable description: use content_hash to read the underlying value.

Examples

use mos_layout::{LayoutEngine, PageBoundarySignature};
use mos_core::Document;
use std::path::PathBuf;

let doc = Document::new(PathBuf::from("doc.mos"));
let result = LayoutEngine::new().layout(&doc);
// Re-signing the same page yields the same signature.
for page in &result.graph.pages {
    assert_eq!(
        PageBoundarySignature::of_page(page),
        PageBoundarySignature::of_page(page),
    );
}

Tuple Fields

0: ContentHash

Implementations

impl PageBoundarySignature

pub fn of_page(page: &Page) -> Self

Compute the boundary signature of one laid-out page.

pub const fn content_hash(self) -> ContentHash

The underlying content hash.

Trait Implementations

impl Clone for PageBoundarySignature

fn clone(&self) -> PageBoundarySignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageBoundarySignature

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

Formats the value using the given formatter.

impl Hash for PageBoundarySignature

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

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 PageBoundarySignature

fn cmp(&self, other: &PageBoundarySignature) -> 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.

impl PartialEq for PageBoundarySignature

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PageBoundarySignature

fn partial_cmp(&self, other: &PageBoundarySignature) -> 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 Copy for PageBoundarySignature

impl Eq for PageBoundarySignature

impl StructuralPartialEq for PageBoundarySignature