Struct rckive_genpdf::elements::UnorderedList

pub struct UnorderedList { /* private fields */ }

An unordered list of elements with bullet points.

Examples

With setters:

use rckive_genpdf::elements;
let mut list = elements::UnorderedList::new();
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));

With setters and a custom bullet symbol:

use rckive_genpdf::elements;
let mut list = elements::UnorderedList::with_bullet("*");
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));

Chained:

use rckive_genpdf::elements;
let list = elements::UnorderedList::new()
    .element(elements::Paragraph::new("first"))
    .element(elements::Paragraph::new("second"))
    .element(elements::Paragraph::new("third"));

Nested list using a LinearLayout:

use rckive_genpdf::elements;
let list = elements::UnorderedList::new()
    .element(
        elements::OrderedList::new()
            .element(elements::Paragraph::new("Sublist with bullet point"))
    )
    .element(
        elements::LinearLayout::vertical()
            .element(elements::Paragraph::new("Sublist without bullet point:"))
            .element(
                elements::OrderedList::new()
                    .element(elements::Paragraph::new("first"))
                    .element(elements::Paragraph::new("second"))
            )
    );

Implementations

impl UnorderedList

pub fn new() -> UnorderedList

Creates a new unordered list with the default bullet point symbol.

pub fn with_bullet(bullet: impl Into<String>) -> UnorderedList

Creates a new unordered list with the given bullet point symbol.

pub fn push<E: Element + 'static>(&mut self, element: E)

Adds an element to this list.

pub fn element<E: Element + 'static>(self, element: E) -> Self

Adds an element to this list and returns the list.

Trait Implementations

impl Default for UnorderedList

fn default() -> UnorderedList

Returns the “default value” for a type.

impl Element for UnorderedList

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

Renders this element to the given area using the given style and font cache.

fn framed(self, line_style: impl Into<LineStyle>) -> FramedElement<Self>where
    Self: Sized,

Draws a frame around this element using the given line style.

fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self>where
    Self: Sized,

Adds a padding to this element.

fn styled(self, style: impl Into<Style>) -> StyledElement<Self>where
    Self: Sized,

Sets the default style for this element and its children.

impl<E: Element + 'static> Extend<E> for UnorderedList

fn extend<I: IntoIterator<Item = E>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<E: Element + 'static> FromIterator<E> for UnorderedList

fn from_iter<I: IntoIterator<Item = E>>(iter: I) -> Self

Creates a value from an iterator.