# Struct rustfmt_nightly::comment::ItemizedBlock

source ·

    struct ItemizedBlock {
        lines: Vec<String>,
        indent: usize,
        opener: String,
        line_start: String,
    }

Expand description

Block that is formatted as an item.

An item starts with either a star `*`, a dash `-`, a greater-than `>`, a plus ‘+’, or a number `12.` or `34)` (with at most 2 digits). An item represents CommonMark’s “list items” and/or “block quotes”, but note that only a subset of CommonMark is recognized - see the doc comment of `ItemizedBlock::get_marker_length` for more details.

Different level of indentation are handled by shrinking the shape accordingly.

## Fields§

§`lines: Vec<String>`

the lines that are identified as part of an itemized block

§`indent: usize`

the number of characters (typically whitespaces) up to the item marker

§`opener: String`

the string that marks the start of an item

§`line_start: String`

sequence of characters (typically whitespaces) to prefix new lines that are part of the item

## Implementations§

source§

### impl ItemizedBlock

source

#### fn get_marker_length(trimmed: &str) -> Option<usize>

Checks whether the `trimmed` line includes an item marker. Returns `None` if there is no marker. Returns the length of the marker (in bytes) if one is present. Note that the length includes the whitespace that follows the marker, for example the marker in `"* list item"` has the length of 2.

This function recognizes item markers that correspond to CommonMark’s “bullet list marker”, “block quote marker”, and/or “ordered list marker”.

Compared to CommonMark specification, the number of digits that are allowed in an “ordered list marker” is more limited (to at most 2 digits). Limiting the length of the marker helps reduce the risk of recognizing arbitrary numbers as markers. See also https://talk.commonmark.org/t/blank-lines-before-lists-revisited/1990 which gives the following example where a number (i.e. “1868”) doesn’t signify an ordered list:

    The Captain died in
    1868. He wes buried in...

source

#### fn new(line: &str) -> Option<ItemizedBlock>

Creates a new `ItemizedBlock` described with the given `line`. Returns `None` if `line` doesn’t start an item.

source

#### fn create_string_format<'a>( &'a self, fmt: &'a StringFormat<'_>, ) -> StringFormat<'a>

Returns a `StringFormat` used for formatting the content of an item.

source

#### fn add_line(&mut self, line: &str) -> bool

Returns `true` if the line is part of the current itemized block. If it is, then it is added to the internal lines list.

source

#### fn trimmed_block_as_string(&self) -> String

Returns the block as a string, with each line trimmed at the start.

source

#### fn original_block_as_string(&self) -> String

Returns the block as a string under its original form.

## Auto Trait Implementations§

§

### impl Freeze for ItemizedBlock

§

### impl RefUnwindSafe for ItemizedBlock

§

### impl Send for ItemizedBlock

§

### impl Sync for ItemizedBlock

§

### impl Unpin for ItemizedBlock

§

### impl UnwindSafe for ItemizedBlock

## 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> Instrument for T

source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
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> IntoEither for T

source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

#### 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.
source§

### impl<T> WithSubscriber for T

source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 80 bytes