Struct doc_chunks::literalset::LiteralSet

pub struct LiteralSet {
    pub coverage: (usize, usize),
    /* private fields */
}

A set of consecutive literals.

Provides means to render them as a code block

Fields

coverage: (usize, usize)

lines spanned (start, end) inclusive

Implementations

impl LiteralSet

pub fn from(literal: TrimmedLiteral) -> Self

Initiate a new set based on the first literal

pub fn add_adjacent(
    &mut self,
    literal: TrimmedLiteral
) -> Result<(), TrimmedLiteral>

Add a literal to a literal set, if the previous lines literal already exists.

Returns literal within the Err variant if not adjacent

pub fn literals<'x>(&'x self) -> Vec<&'x TrimmedLiteral>

The set of trimmed literals that is covered.

pub fn len(&self) -> usize

The number of literals inside this set.

pub fn into_chunk(self) -> CheckableChunk

Convert to a checkable chunk.

Creates the map from content ranges to source spans.

Trait Implementations

impl Clone for LiteralSet

fn clone(&self) -> LiteralSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiteralSet

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

Formats the value using the given formatter.

impl Default for LiteralSet

fn default() -> LiteralSet

Returns the “default value” for a type.

impl<'s> Display for LiteralSet

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

Formats the value using the given formatter.

impl Hash for LiteralSet

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 PartialEq<LiteralSet> for LiteralSet

fn eq(&self, other: &LiteralSet) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for LiteralSet

impl StructuralEq for LiteralSet

impl StructuralPartialEq for LiteralSet