Struct ListBlock 

pub struct ListBlock<'src> { /* private fields */ }

A list contains a sequence of items prefixed with symbol, such as a disc (aka bullet). Each individual item in the list is represented by a ListItem.

Implementations

impl<'src> ListBlock<'src>

pub fn type_(&self) -> ListType

Returns the type of this list.

pub fn is_checklist(&self) -> bool

Returns true if this list is a checklist (i.e. task list).

An unordered list becomes a checklist when at least one of its items uses checkbox syntax ([ ], [x], or [*]). See ListItem::checkbox.

pub fn is_bibliography(&self) -> bool

Returns true if this list carries the bibliography style.

A list is a bibliography list when it is an unordered list that is either explicitly marked [bibliography] or appears as a top-level list within a section that carries the bibliography style (the section implicitly adds the style to each of its unordered lists). Each item of such a list may begin with a bibliography anchor ([[[id]]]).

pub fn marker_style(&self) -> Option<&'static str>

Returns the style class for this list based on the marker length. For ordered lists, the style is determined by the number of dots:

• 1 dot: arabic (1, 2, 3, …)
• 2 dots: loweralpha (a, b, c, …)
• 3 dots: lowerroman (i, ii, iii, …)
• 4 dots: upperalpha (A, B, C, …)
• 5 dots: upperroman (I, II, III, …)

pub fn start(&self) -> Option<i64>

Returns the starting ordinal a converter should emit as the start attribute of an HTML <ol>, if any.

An ordered list can begin at a value other than 1 in two ways (matching Asciidoctor):

• an explicit [start=N] attribute, which takes precedence; or
• the ordinal of an explicit first-item marker — for example 7. (arabic), c. (loweralpha, ⇒ 3), or iv) (lowerroman, ⇒ 4).

The result is None whenever the start resolves to the default of 1 — whether from implicit markers (e.g. .), an explicit ordinal-1 marker (1., a., i)), or [start=1] — because a converter emits a bare <ol> in that case. It is likewise None for a list that is not ordered. So start() is Some(n) exactly when a converter must emit a non-default start="n", mirroring the ordinal != 1 guard in this crate’s own reference renderer.

Trait Implementations

impl<'src> Clone for ListBlock<'src>

fn clone(&self) -> ListBlock<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListBlock<'_>

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

Formats the value using the given formatter.

impl<'src> Eq for ListBlock<'src>

impl<'src> HasSpan<'src> for ListBlock<'src>

fn span(&self) -> Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> IsBlock<'src> for ListBlock<'src>

fn content_model(&self) -> ContentModel

Returns the ContentModel for this block.

fn raw_context(&self) -> CowStr<'src>

Returns the raw (uninterpreted) context for this block.

fn nested_blocks(&'src self) -> Iter<'src, Block<'src>>

Returns an iterator over the nested blocks contained within this block.

fn nested_blocks_mut(&mut self) -> &mut [Block<'src>]

Returns a mutable slice of the nested blocks contained within this block.

fn title_source(&'src self) -> Option<Span<'src>>

Returns the source text for the title for this block, if present.

fn title(&self) -> Option<&str>

Returns the rendered title for this block, if present.

fn anchor(&'src self) -> Option<Span<'src>>

Returns the anchor for this block, if present.

fn anchor_reftext(&'src self) -> Option<Span<'src>>

Returns the reference text for this block’s anchor, if present.

fn attrlist(&'src self) -> Option<&'src Attrlist<'src>>

Returns the attribute list for this block, if present.

fn rendered_content(&'src self) -> Option<&'src str>

Returns the rendered content for this block, if any.

fn resolved_context(&'src self) -> CowStr<'src>

Returns the resolved context for this block.

fn declared_style(&'src self) -> Option<&'src str>

Returns the declared (uninterpreted) style for this block.

fn content_mut(&mut self) -> Option<&mut Content<'src>>

Returns a mutable reference to this block’s own resolvable content — its body, section title, or description-list term — if any.

fn id(&'src self) -> Option<&'src str>

Returns the ID for this block, if present.

fn roles(&'src self) -> Vec<&'src str>

Returns any role attributes that were found.

fn options(&'src self) -> Vec<&'src str>

Returns any option attributes that were found.

fn has_option<N: AsRef<str>>(&'src self, name: N) -> bool

Returns true if this block has the named option.

fn caption(&self) -> Option<&str>

Returns the caption prefix for this block, if it has one.

fn number(&self) -> Option<usize>

Returns the automatically assigned number for this block, if it has one.

fn substitution_group(&'src self) -> SubstitutionGroup

Returns the default substitution group that is applied unless you customize the substitutions for a particular element.

impl<'src> PartialEq for ListBlock<'src>

fn eq(&self, other: &ListBlock<'src>) -> 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<'src> StructuralPartialEq for ListBlock<'src>