Struct RepeatElem

pub struct RepeatElem {
    pub body: Content,
    /* private fields */
}

Repeats content to the available space.

This can be useful when implementing a custom index, reference, or outline.

Space may be inserted between the instances of the body parameter, so be sure to adjust the justify parameter accordingly.

Errors if there are no bounds on the available space, as it would create infinite content.

Example

Sign on the dotted line:
#box(width: 1fr, repeat[.])

#set text(10pt)
#v(8pt, weak: true)
#align(right)[
  Berlin, the 22nd of December, 2022
]

Fields

body: Content

Implementations

impl RepeatElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_gap(self, gap: Length) -> Self

Builder-style setter for the gap field.

pub fn with_justify(self, justify: bool) -> Self

Builder-style setter for the justify field.

pub fn push_gap(&mut self, gap: Length)

Setter for the gap field.

pub fn push_justify(&mut self, justify: bool)

Setter for the justify field.

pub fn gap(&self, styles: StyleChain<'_>) -> Length

The gap between each instance of the body.

pub fn justify(&self, styles: StyleChain<'_>) -> bool

Whether to increase the gap between instances to completely fill the available space.

pub fn gap_in(styles: StyleChain<'_>) -> Length

Access the gap field in the given style chain.

pub fn justify_in(styles: StyleChain<'_>) -> bool

Access the justify field in the given style chain.

pub fn set_gap(gap: Length) -> Property

Create a style property for the gap field.

pub fn set_justify(justify: bool) -> Property

Create a style property for the justify field.

Trait Implementations

impl Capable for RepeatElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for RepeatElem

fn clone(&self) -> RepeatElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for RepeatElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for RepeatElem

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

Formats the value using the given formatter.

impl Fields for RepeatElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl Hash for RepeatElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for RepeatElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for RepeatElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for RepeatElem

fn eq(&self, other: &Self) -> 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 Repr for RepeatElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for RepeatElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.