Struct List 

pub struct List {
    pub items: Vec<ListItem>,
    pub marker_width: f32,
    pub gap: f32,
    pub common: Common,
    /* private fields */
}

Fields

items: Vec<ListItem>

marker_width: f32

gap: f32

common: Common

Implementations

impl List

pub fn new() -> List

Examples found in repository

examples/report.rs (line 44)

fn main() {
    let mut doc = Document::new(PageFormat::A4)
        .margin(Margin::symmetric(56.0, 56.0))
        .header(Header::new(20.0, |_ctx| {
            Text::new("Jahresbericht 2026 \u{2014} Muster GmbH").size(9.0).into()
        }))
        .header_visible_from(2)
        .footer(Footer::new(20.0, |ctx| {
            Text::new(format!("Seite {} von {}", ctx.page, ctx.total_pages))
                .size(9.0)
                .align(Align::Center)
                .into()
        }))
        .watermark(Watermark::new("ENTWURF"));

    // --- cover page -----------------------------------------------------
    doc.add(Spacer::new(220.0));
    doc.add(Text::new("Jahresbericht 2026").heading1().align(Align::Center));
    doc.add(Spacer::new(8.0));
    doc.add(Text::new("Muster GmbH").align(Align::Center));
    doc.add(Text::new("vorgelegt am 20. August 2026").align(Align::Center));
    doc.add(Element::PageBreak);

    // --- content ---------------------------------------------------------
    doc.add(Text::new("1. Zusammenfassung").heading1());
    doc.add(Text::new(
        "Das Geschäftsjahr 2026 war geprägt von stabilem Wachstum in allen \
         Kernbereichen. Die folgenden Abschnitte fassen die wichtigsten \
         Kennzahlen und Entwicklungen zusammen.",
    ));
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("2. Wichtigste Ereignisse").heading2());
    doc.add(
        List::new()
            .bullet(Text::new("Markteinführung des neuen Produkts im zweiten Quartal"))
            .bullet(Text::new("Erweiterung des Teams um 12 neue Mitarbeitende"))
            .bullet(Text::new("Eröffnung eines zweiten Standorts")),
    );
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("3. Zeitplan").heading2());
    doc.add(
        List::new()
            .numbered(Text::new("Kickoff und Planung (Januar \u{2013} Februar)"))
            .numbered(Text::new("Umsetzung Phase 1 (M\u{e4}rz \u{2013} Juni)"))
            .numbered(Text::new("Umsetzung Phase 2 (Juli \u{2013} Oktober)"))
            .numbered(Text::new("Abschluss und Auswertung (November \u{2013} Dezember)")),
    );
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("3.1 Details").heading3());
    doc.add(Text::new(
        "Weitere Details zu den einzelnen Phasen finden sich im Anhang. \
         Diese Überschrift bleibt dank keep_with_next garantiert mit \
         diesem Absatz auf derselben Seite zusammen.",
    ));

    let bytes = doc.render().expect("render should succeed");
    std::fs::write("report.pdf", &bytes).expect("write report.pdf");
    println!("wrote report.pdf ({} bytes)", bytes.len());
}

pub fn bullet(self, content: impl Into<Element>) -> List

Examples found in repository

examples/report.rs (line 45)

fn main() {
    let mut doc = Document::new(PageFormat::A4)
        .margin(Margin::symmetric(56.0, 56.0))
        .header(Header::new(20.0, |_ctx| {
            Text::new("Jahresbericht 2026 \u{2014} Muster GmbH").size(9.0).into()
        }))
        .header_visible_from(2)
        .footer(Footer::new(20.0, |ctx| {
            Text::new(format!("Seite {} von {}", ctx.page, ctx.total_pages))
                .size(9.0)
                .align(Align::Center)
                .into()
        }))
        .watermark(Watermark::new("ENTWURF"));

    // --- cover page -----------------------------------------------------
    doc.add(Spacer::new(220.0));
    doc.add(Text::new("Jahresbericht 2026").heading1().align(Align::Center));
    doc.add(Spacer::new(8.0));
    doc.add(Text::new("Muster GmbH").align(Align::Center));
    doc.add(Text::new("vorgelegt am 20. August 2026").align(Align::Center));
    doc.add(Element::PageBreak);

    // --- content ---------------------------------------------------------
    doc.add(Text::new("1. Zusammenfassung").heading1());
    doc.add(Text::new(
        "Das Geschäftsjahr 2026 war geprägt von stabilem Wachstum in allen \
         Kernbereichen. Die folgenden Abschnitte fassen die wichtigsten \
         Kennzahlen und Entwicklungen zusammen.",
    ));
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("2. Wichtigste Ereignisse").heading2());
    doc.add(
        List::new()
            .bullet(Text::new("Markteinführung des neuen Produkts im zweiten Quartal"))
            .bullet(Text::new("Erweiterung des Teams um 12 neue Mitarbeitende"))
            .bullet(Text::new("Eröffnung eines zweiten Standorts")),
    );
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("3. Zeitplan").heading2());
    doc.add(
        List::new()
            .numbered(Text::new("Kickoff und Planung (Januar \u{2013} Februar)"))
            .numbered(Text::new("Umsetzung Phase 1 (M\u{e4}rz \u{2013} Juni)"))
            .numbered(Text::new("Umsetzung Phase 2 (Juli \u{2013} Oktober)"))
            .numbered(Text::new("Abschluss und Auswertung (November \u{2013} Dezember)")),
    );
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("3.1 Details").heading3());
    doc.add(Text::new(
        "Weitere Details zu den einzelnen Phasen finden sich im Anhang. \
         Diese Überschrift bleibt dank keep_with_next garantiert mit \
         diesem Absatz auf derselben Seite zusammen.",
    ));

    let bytes = doc.render().expect("render should succeed");
    std::fs::write("report.pdf", &bytes).expect("write report.pdf");
    println!("wrote report.pdf ({} bytes)", bytes.len());
}

pub fn numbered(self, content: impl Into<Element>) -> List

Appends a numbered item, auto-incrementing from 1.

Examples found in repository

examples/report.rs (line 54)

fn main() {
    let mut doc = Document::new(PageFormat::A4)
        .margin(Margin::symmetric(56.0, 56.0))
        .header(Header::new(20.0, |_ctx| {
            Text::new("Jahresbericht 2026 \u{2014} Muster GmbH").size(9.0).into()
        }))
        .header_visible_from(2)
        .footer(Footer::new(20.0, |ctx| {
            Text::new(format!("Seite {} von {}", ctx.page, ctx.total_pages))
                .size(9.0)
                .align(Align::Center)
                .into()
        }))
        .watermark(Watermark::new("ENTWURF"));

    // --- cover page -----------------------------------------------------
    doc.add(Spacer::new(220.0));
    doc.add(Text::new("Jahresbericht 2026").heading1().align(Align::Center));
    doc.add(Spacer::new(8.0));
    doc.add(Text::new("Muster GmbH").align(Align::Center));
    doc.add(Text::new("vorgelegt am 20. August 2026").align(Align::Center));
    doc.add(Element::PageBreak);

    // --- content ---------------------------------------------------------
    doc.add(Text::new("1. Zusammenfassung").heading1());
    doc.add(Text::new(
        "Das Geschäftsjahr 2026 war geprägt von stabilem Wachstum in allen \
         Kernbereichen. Die folgenden Abschnitte fassen die wichtigsten \
         Kennzahlen und Entwicklungen zusammen.",
    ));
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("2. Wichtigste Ereignisse").heading2());
    doc.add(
        List::new()
            .bullet(Text::new("Markteinführung des neuen Produkts im zweiten Quartal"))
            .bullet(Text::new("Erweiterung des Teams um 12 neue Mitarbeitende"))
            .bullet(Text::new("Eröffnung eines zweiten Standorts")),
    );
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("3. Zeitplan").heading2());
    doc.add(
        List::new()
            .numbered(Text::new("Kickoff und Planung (Januar \u{2013} Februar)"))
            .numbered(Text::new("Umsetzung Phase 1 (M\u{e4}rz \u{2013} Juni)"))
            .numbered(Text::new("Umsetzung Phase 2 (Juli \u{2013} Oktober)"))
            .numbered(Text::new("Abschluss und Auswertung (November \u{2013} Dezember)")),
    );
    doc.add(Spacer::new(12.0));

    doc.add(Text::new("3.1 Details").heading3());
    doc.add(Text::new(
        "Weitere Details zu den einzelnen Phasen finden sich im Anhang. \
         Diese Überschrift bleibt dank keep_with_next garantiert mit \
         diesem Absatz auf derselben Seite zusammen.",
    ));

    let bytes = doc.render().expect("render should succeed");
    std::fs::write("report.pdf", &bytes).expect("write report.pdf");
    println!("wrote report.pdf ({} bytes)", bytes.len());
}

pub fn marker_width(self, width: f32) -> List

pub fn gap(self, gap: f32) -> List

pub fn width(self, width: f32) -> List

pub fn height(self, height: f32) -> List

pub fn flex(self, factor: f32) -> List

pub fn keep_with_next(self) -> List

Trait Implementations

impl Clone for List

fn clone(&self) -> List

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for List

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

Formats the value using the given formatter.

impl Default for List

fn default() -> List

Returns the “default value” for a type.

impl From<List> for Element

fn from(value: List) -> Element

Converts to this type from the input type.

impl Layoutable for List

fn measure(&self, ctx: &LayoutCtx<'_>, constraints: Constraints) -> Size

fn layout( &self, ctx: &LayoutCtx<'_>, area: Rect, warnings: &mut Vec<LayoutWarning>, page: usize, ) -> LayoutResult