Struct SimplePageDecorator 

pub struct SimplePageDecorator {
    pub(crate) page: usize,
    pub(crate) margins: Option<Margins>,
    pub(crate) header_cb: Option<Box<dyn Fn(usize) -> Box<dyn Element>>>,
}

Prepares a page of a document with margins and a header.

Per default, this decorator does not modify the page. If margins have been set with the set_margins method, they are applied to every page. If a header callback is configured with the set_header method, it will be called for every page and its return value will be rendered at the beginning of the page (after the margins have been applied).

Fields

page: usize

margins: Option<Margins>

header_cb: Option<Box<dyn Fn(usize) -> Box<dyn Element>>>

Implementations

impl SimplePageDecorator

pub fn new() -> SimplePageDecorator

Creates a new page decorator that does not modify the page.

pub fn clone_for_document(&self) -> SimplePageDecorator

Returns a clone of this decorator suitable for attaching to another Document.

Note: the header callback is not cloned (it is set to None on the clone) because boxed closures are not universally cloneable. This preserves the margins and resets the page counter to 0 for the cloned instance.

pub fn set_margins(&mut self, margins: impl Into<Margins>)

Sets the margins for all pages of this document.

If this method is not called, the full page is used.

pub fn set_header<F, E>(&mut self, cb: F)

where F: Fn(usize) -> E + 'static, E: Element + 'static,

Sets the header generator for this document.

The given closure will be called once per page. Its argument is the page number (starting with 1), and its return value will be rendered at the top of the page. The document content will start directly after the element.

pub fn margins(&self) -> Option<Margins>

Return the margins currently configured for this decorator (useful for testing).

Trait Implementations

impl Clone for SimplePageDecorator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SimplePageDecorator

fn default() -> SimplePageDecorator

Returns the “default value” for a type.

impl PageDecorator for SimplePageDecorator

fn decorate_page<'a>( &mut self, context: &Context, area: Area<'a>, style: Style, ) -> Result<Area<'a>, Error>

Prepares the page with the given area before it is filled with the document content and returns the writable area of the page.