Struct ListItem 

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

A list item is a special kind of block that contains one or more blocks attached to it. In the simplest case, this will be a single SimpleBlock with the principal text for the list item. In other cases, it may be any number of blocks of any type which, together, form an entry in a list which is the immediate parent of this block.

Implementations

impl<'src> ListItem<'src>

pub fn child_blocks(&'src self) -> ChildBlocks<'src>

Returns a document-order iterator over this list item’s direct child blocks.

For the full subtree, or to search from a Block or Document, use FindBlocks.

pub fn list_item_marker(&self) -> ListItemMarker<'src>

Returns the list item marker that was used for this item.

pub fn checkbox(&self) -> Option<bool>

Returns the checklist (i.e. task list) state of this item.

An unordered list item whose principal text begins with a checkbox marker ([ ] , [x] , or [*] ) is a checklist item. The returned value is Some(true) for a checked item ([x]/[*]), Some(false) for an unchecked item ([ ]), or None if the item is not a checklist item.

pub fn has_empty_principal_text(&self) -> bool

Reports whether this item has principal text that is present in the source but renders empty (for example, principal text written as the {empty} attribute reference).

Such an empty principal text node is not emitted as a child block (see child_blocks); this flag preserves the fact that it was there. It distinguishes an item whose principal text is empty – so a renderer emits an empty principal paragraph ahead of any continuation-attached blocks (as Asciidoctor does) – from an item that simply has no principal text. When it is true, the item’s first child block is an attached block rather than the principal text.

Trait Implementations

impl<'src> Clone for ListItem<'src>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListItem<'_>

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

Formats the value using the given formatter.

impl<'src> Eq for ListItem<'src>

impl<'src> HasSpan<'src> for ListItem<'src>

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

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

impl<'src> Hash for ListItem<'src>

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<'src> IsBlock<'src> for ListItem<'src>

fn content_model(&self) -> ContentModel

Returns the ContentModel 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 or description-list term – if any.

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

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

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

Returns the raw (uninterpreted) context for 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 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 ListItem<'src>

fn eq(&self, other: &ListItem<'src>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'src> StructuralPartialEq for ListItem<'src>