Struct doc_chunks::span::Span

pub struct Span {
    pub start: LineColumn,
    pub end: LineColumn,
}

Relative span in relation to the beginning of a doc comment.

Line values are 1-indexed relative, lines are inclusive. Column values in UTF-8 characters in a line, 0-indexed and inclusive.

Fields

start: LineColumn

Start of the span, inclusive, see LineColumn.

end: LineColumn

End of the span, inclusive, see LineColumn.

Implementations

impl Span

pub fn relative_to<X: Into<Span>>(&self, scope: X) -> Result<Range>

Converts a span to a range, where self is converted to a range relative to the passed span scope. Only works for literals spanning a single line and the scope full contains self, otherwise an an Err(..)` is returned.

pub fn covers_line(&self, line: usize) -> bool

Check if self span covers provided line number, which is 1-indexed.

pub fn one_line_len(&self) -> Option<usize>

If this one resembles a single line, returns the a Some(len) value. For multilines this cannot account for the length.

pub fn is_multiline(&self) -> bool

Check if self covers multiple lines

pub fn to_content_range(&self, chunk: &CheckableChunk) -> Result<Range>

Convert a given span self into a Range

The Chunk has a associated Span (or a set of Range -> Span mappings) which are used to map.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl From<&TrimmedLiteral> for Span

fn from(literal: &TrimmedLiteral) -> Self

Converts to this type from the input type.

impl From<Span> for Span

fn from(original: Span) -> Self

Converts to this type from the input type.

impl Hash for Span

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<Span> for Span

fn eq(&self, other: &Span) -> 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 TryFrom<(usize, Range<usize>)> for Span

type Error = Error

The type returned in the event of a conversion error.

fn try_from(original: (usize, Range)) -> Result<Self>

Performs the conversion.

impl TryFrom<(usize, RangeInclusive<usize>)> for Span

type Error = Error

The type returned in the event of a conversion error.

fn try_from(original: (usize, RangeInclusive<usize>)) -> Result<Self>

Performs the conversion.

impl TryInto<Range<usize>> for &Span

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Range>

Performs the conversion.

impl TryInto<Range<usize>> for Span

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Range>

Performs the conversion.

impl Copy for Span

impl Eq for Span

impl StructuralEq for Span

impl StructuralPartialEq for Span