Struct Workbook 

#[non_exhaustive]
pub struct Workbook { /* private fields */ }

An Excel workbook with several sheets, each one a grid’s export of a query (needs renox’s xlsx feature; without it Workbook::sheet answers 400, like the single-sheet export). Sheets appear in the order they are added; each uses the grid’s columns that show by default on wide screens, with the same headings, number formats and frozen columns as Grid::export_as.

use renox::grid::{Column, Grid, GridRequest, Workbook};
// GET /reports/summary.xlsx
async fn summary(request: GridRequest) -> Result<Response> {
    let sales = Grid::new("sales").column(Column::money("total", "Total"));
    let refunds = Grid::new("refunds").column(Column::money("amount", "Amount"));
    Workbook::new("summary")
        .sheet("Sales", &sales, Sale::query().order_by("id"), &request).await?
        .sheet("Refunds", &refunds, Refund::query().order_by("id"), &request).await?
        .into_response()
}

Implementations

impl Workbook

pub fn new(name: impl Into<String>) -> Self

A workbook whose file is {name}-{date}.xlsx.

pub async fn sheet<M: Model + Serialize>( self, title: &str, grid: &Grid, query: Query<M>, request: &GridRequest, ) -> Result<Self>

Adds a sheet called title (at most 31 characters, none of []:*?/\, unique in the workbook) with every row query matches, up to MAX_EXPORT_ROWS. The request’s filters and the user’s column choices don’t apply (as in Grid::export_as).

pub fn into_response(self) -> Result<Response>

The .xlsx download of the sheets added so far.