Skip to main content

BulletPoint

Struct BulletPoint 

Source
pub struct BulletPoint<E: Element> { /* private fields */ }
Expand description

A bullet point in a list.

This is a helper element for the OrderedList and UnorderedList types, but you can also use it directly if you have special requirements.

§Example

use genpdf::elements;
let layout = elements::LinearLayout::vertical()
    .element(elements::BulletPoint::new(elements::Paragraph::new("first"))
        .with_bullet("a)"))
    .element(elements::BulletPoint::new(elements::Paragraph::new("second"))
        .with_bullet("b)"));

Implementations§

Source§

impl<E: Element> BulletPoint<E>

Source

pub fn new(element: E) -> BulletPoint<E>

Creates a new bullet point with the given element.

Source

pub fn set_bullet(&mut self, bullet: impl Into<String>)

Sets the bullet point symbol for this bullet point.

Source

pub fn with_bullet(self, bullet: impl Into<String>) -> Self

Sets the bullet point symbol for this bullet point and returns the bullet point.

Trait Implementations§

Source§

impl<E: Element> Element for BulletPoint<E>

Source§

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

fn framed(self) -> FramedElement<Self>
where Self: Sized,

Draws a frame around this element.
Source§

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

Adds a padding to this element.
Source§

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

Sets the default style for this element and its children.

Auto Trait Implementations§

§

impl<E> Freeze for BulletPoint<E>
where E: Freeze,

§

impl<E> RefUnwindSafe for BulletPoint<E>
where E: RefUnwindSafe,

§

impl<E> Send for BulletPoint<E>
where E: Send,

§

impl<E> Sync for BulletPoint<E>
where E: Sync,

§

impl<E> Unpin for BulletPoint<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for BulletPoint<E>
where E: UnsafeUnpin,

§

impl<E> UnwindSafe for BulletPoint<E>
where E: UnwindSafe,

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
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, 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.