SimplePageDecorator

Struct SimplePageDecorator 

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

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§

Source§

impl SimplePageDecorator

Source

pub fn new() -> SimplePageDecorator

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

Source

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.

Source

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.

Trait Implementations§

Source§

impl Default for SimplePageDecorator

Source§

fn default() -> SimplePageDecorator

Returns the “default value” for a type. Read more
Source§

impl PageDecorator for SimplePageDecorator

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Finish for T

§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

§

fn to_owned_table(&self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V