Struct PagebreakElem

pub struct PagebreakElem { /* private fields */ }

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 ...

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.

pub fn push_weak(&mut self, weak: bool)

Setter for the weak field.

pub fn push_to(&mut self, to: Option<Parity>)

Setter for the to field.

pub fn push_boundary(&mut self, boundary: bool)

Setter for the boundary field.

pub fn weak(&self, styles: StyleChain<'_>) -> bool

If {true}, the page break is skipped if the current page is already empty.

pub fn to(&self, styles: StyleChain<'_>) -> Option<Parity>

If given, ensures that the next page will be an even/odd page, with an empty page in between if necessary.

#set page(height: 30pt)

First.
#pagebreak(to: "odd")
Third.

pub fn boundary(&self, styles: StyleChain<'_>) -> bool

Whether this pagebreak designates an end boundary of a page run. This is an even weaker version of pagebreak weak because it not only doesn’t force an empty page, but also doesn’t force its initial styles onto a staged empty page.

pub fn weak_in(styles: StyleChain<'_>) -> bool

Access the weak field in the given style chain.

pub fn to_in(styles: StyleChain<'_>) -> Option<Parity>

Access the to field in the given style chain.

pub fn boundary_in(styles: StyleChain<'_>) -> bool

Access the boundary field in the given style chain.

pub fn set_weak(weak: bool) -> Property

Create a style property for the weak field.

pub fn set_to(to: Option<Parity>) -> Property

Create a style property for the to field.

pub fn set_boundary(boundary: bool) -> Property

Create a style property for the boundary field.

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

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for PagebreakElem

fn clone(&self) -> PagebreakElem

Returns a copy 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 Fields for PagebreakElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

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

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for PagebreakElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for PagebreakElem

fn eq(&self, other: &Self) -> 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 Repr for PagebreakElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for PagebreakElem

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

Parse relevant arguments into style properties for this element.