Struct EnumElem 

pub struct EnumElem {
    pub tight: Settable<Self, 0u8>,
    pub numbering: Settable<Self, 1u8>,
    pub start: Settable<Self, 2u8>,
    pub full: Settable<Self, 3u8>,
    pub reversed: Settable<Self, 4u8>,
    pub indent: Settable<Self, 5u8>,
    pub body_indent: Settable<Self, 6u8>,
    pub spacing: Settable<Self, 7u8>,
    pub number_align: Settable<Self, 8u8>,
    pub children: Vec<Packed<EnumItem>>,
}

A numbered list.

Displays a sequence of items vertically and numbers them consecutively.

Example

Automatically numbered:
+ Preparations
+ Analysis
+ Conclusions

Manually numbered:
2. What is the first step?
5. I am confused.
+  Moving on ...

Multiple lines:
+ This enum item has multiple
  lines because the next line
  is indented.

Function call.
#enum[First][Second]

You can easily switch all your enumerations to a different numbering style with a set rule.

#set enum(numbering: "a)")

+ Starting off ...
+ Don't forget step two

You can also use [enum.item] to programmatically customize the number of each item in the enumeration:

#enum(
  enum.item(1)[First step],
  enum.item(5)[Fifth step],
  enum.item(10)[Tenth step]
)

Syntax

This functions also has dedicated syntax:

• Starting a line with a plus sign creates an automatically numbered enumeration item.
• Starting a line with a number followed by a dot creates an explicitly numbered enumeration item.

Enumeration items can contain multiple paragraphs and other block-level content. All content that is indented more than an item’s marker becomes part of that item.

Fields

tight: Settable<Self, 0u8>

numbering: Settable<Self, 1u8>

start: Settable<Self, 2u8>

full: Settable<Self, 3u8>

reversed: Settable<Self, 4u8>

indent: Settable<Self, 5u8>

body_indent: Settable<Self, 6u8>

spacing: Settable<Self, 7u8>

number_align: Settable<Self, 8u8>

children: Vec<Packed<EnumItem>>

Implementations

impl EnumElem

pub fn new(children: Vec<Packed<EnumItem>>) -> Self

Create a new instance of the element.

pub fn with_tight(self, tight: bool) -> Self

Builder-style setter for the tight field.

pub fn with_numbering(self, numbering: Numbering) -> Self

Builder-style setter for the numbering field.

pub fn with_start(self, start: Smart<u64>) -> Self

Builder-style setter for the start field.

pub fn with_full(self, full: bool) -> Self

Builder-style setter for the full field.

pub fn with_reversed(self, reversed: bool) -> Self

Builder-style setter for the reversed field.

pub fn with_indent(self, indent: Length) -> Self

Builder-style setter for the indent field.

pub fn with_body_indent(self, body_indent: Length) -> Self

Builder-style setter for the body-indent field.

pub fn with_spacing(self, spacing: Smart<Length>) -> Self

Builder-style setter for the spacing field.

pub fn with_number_align(self, number_align: Alignment) -> Self

Builder-style setter for the number-align field.

impl EnumElem

pub const tight: Field<Self, 0u8>

pub const numbering: Field<Self, 1u8>

pub const start: Field<Self, 2u8>

pub const full: Field<Self, 3u8>

pub const reversed: Field<Self, 4u8>

pub const indent: Field<Self, 5u8>

pub const body_indent: Field<Self, 6u8>

pub const spacing: Field<Self, 7u8>

pub const number_align: Field<Self, 8u8>

pub const children: Field<Self, 9u8>

pub const parents: Field<Self, 10u8>

Trait Implementations

impl Clone for EnumElem

fn clone(&self) -> EnumElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for EnumElem

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

Construct an element from the arguments.

impl Debug for EnumElem

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

Formats the value using the given formatter.

impl Hash for EnumElem

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 ListLike for EnumElem

type Item = EnumItem

The kind of list item this list is composed of.

fn create(children: Vec<Packed<Self::Item>>, tight: bool) -> Self

Create this kind of list from its children and tightness.

impl NativeElement for EnumElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl NativeScope for EnumElem

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl RequiredField<9> for EnumElem

const FIELD: RequiredFieldData<Self, 9u8>

type Type = Vec<Packed<EnumItem>>

impl Set for EnumElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for EnumElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = bool

impl SettableField<1> for EnumElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Numbering

impl SettableField<2> for EnumElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Smart<u64>

impl SettableField<3> for EnumElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = bool

impl SettableField<4> for EnumElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = bool

impl SettableField<5> for EnumElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = Length

impl SettableField<6> for EnumElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = Length

impl SettableField<7> for EnumElem

const FIELD: SettableFieldData<Self, 7u8>

type Type = Smart<Length>

impl SettableField<8> for EnumElem

const FIELD: SettableFieldData<Self, 8u8>

type Type = Alignment

impl SettableProperty<10> for EnumElem

const FIELD: SettablePropertyData<Self, 10u8>

type Type = SmallVec<[u64; 4]>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl RefableProperty<0> for EnumElem

impl RefableProperty<1> for EnumElem

impl RefableProperty<2> for EnumElem

impl RefableProperty<3> for EnumElem

impl RefableProperty<4> for EnumElem

impl RefableProperty<5> for EnumElem

impl RefableProperty<6> for EnumElem

impl RefableProperty<7> for EnumElem

impl RefableProperty<8> for EnumElem