Struct PagebreakElem 

pub struct PagebreakElem {
    pub weak: Settable<Self, 0u8>,
    pub to: Settable<Self, 1u8>,
    pub boundary: Settable<Self, 2u8>,
}

A manual page break.

Must not be used inside any containers.

Example

The next page contains
more details on compound theory.
#pagebreak()

== Compound Theory
In 1984, the first ...

Even without manual page breaks, content will be automatically paginated based on the configured page size. You can set the page height to {auto} to let the page grow dynamically until a manual page break occurs.

Pagination tries to avoid single lines of text at the top or bottom of a page (these are called widows and orphans). You can adjust the [text.costs] parameter to disable this behavior.

Fields

weak: Settable<Self, 0u8>

to: Settable<Self, 1u8>

boundary: Settable<Self, 2u8>

Implementations

impl PagebreakElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_weak(self, weak: bool) -> Self

Builder-style setter for the weak field.

pub fn with_to(self, to: Option<Parity>) -> Self

Builder-style setter for the to field.

pub fn with_boundary(self, boundary: bool) -> Self

Builder-style setter for the boundary field.

impl PagebreakElem

pub const weak: Field<Self, 0u8>

pub const to: Field<Self, 1u8>

pub const boundary: Field<Self, 2u8>

impl PagebreakElem

pub fn shared_weak() -> &'static Content

Get the globally shared weak pagebreak element.

pub fn shared_boundary() -> &'static Content

Get the globally shared boundary pagebreak element.

Trait Implementations

impl Clone for PagebreakElem

fn clone(&self) -> PagebreakElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for PagebreakElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for PagebreakElem

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

Formats the value using the given formatter.

impl Hash for PagebreakElem

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 NativeElement for PagebreakElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl Set for PagebreakElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableField<0> for PagebreakElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = bool

impl SettableField<1> for PagebreakElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Option<Parity>

impl SettableField<2> for PagebreakElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = bool

impl RefableProperty<0> for PagebreakElem

impl RefableProperty<1> for PagebreakElem

impl RefableProperty<2> for PagebreakElem