Enum Band 

pub enum Band {
    Title(Vec<Element>),
    PageHeader(Vec<Element>),
    ColumnHeader(Vec<Element>),
    Detail(Vec<Element>),
    ColumnFooter(Vec<Element>),
    PageFooter(Vec<Element>),
    Summary(Vec<Element>),
    Custom(String, Vec<Element>),
}

Band is a section of a document(Title, PageHeader, ColumnHeader, Detail, ColumnFooter, PageFooter, Summary).

Each band contains a list of elements (Text, Table, List, Image, Hyperlink…).

Bands are used to organize the content of a document.

Documents in general have a predefined set of bands, but custom bands can be created.

PageHeader, Detail, PageFooter are the most common bands and is used to display the header, main content, and footer of documents of any type(XML, CSV, JSON…).

The logic to handle custom bands is up to the user/file format

Variants

Title(Vec<Element>)

This band happens only once at the beginning of the document and is not repeated.

PageHeader(Vec<Element>)

This band happens only once at the beginning of the document and is repeated every page. Title and summary bands are mutually exclusive The PageHeader band is also used to display the header of documents of any type, commonly used in conjunction with the Detail and PageFooter band

ColumnHeader(Vec<Element>)

This band is printed at the beginning of each detail section. Usually, labels containing the column names of a tabular report are inserted in this band.

Detail(Vec<Element>)

This band is repeated for every single read record. It contains the main content of the document The detail band is the most common band and is used to display the main content of the document of any type

ColumnFooter(Vec<Element>)

This band is printed at the end of each detail section.

PageFooter(Vec<Element>)

This band happens only once at the end of the document and is repeated every page.

Summary(Vec<Element>)

This band happens only once at the end of the document and is not repeated.

Custom(String, Vec<Element>)

This is a custom band, receiving a unique name and a list of elements The logic to handle this band is up to the user/file format

Implementations

impl Band

pub fn elements(&self) -> &Vec<Element>

Trait Implementations

impl Clone for Band

fn clone(&self) -> Band

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Band

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Band

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Band

fn eq(&self, other: &Band) -> 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 Serialize for Band

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Band