Enum doc_chunks::markdown::SourceRange

pub enum SourceRange {
    Direct(Range),
    Alias(Range, String),
}

Describes whether there is a matching segment in the source, of if it is a placeholder for i.e. a code block or inline code. These placeholders are required for grammar checks.

Variants

Direct(Range)

Alias(Range, String)

Implementations

impl SourceRange

pub fn range(&self) -> Range

Extract a clone of the inner Range<usize>.

Use deref() or * for a reference.

Methods from Deref<Target = Range>

pub fn contains<U>(&self, item: &U) -> bool

where Idx: PartialOrd<U>, U: PartialOrd<Idx> + ?Sized,

Returns true if item is contained in the range.

Examples

assert!(!(3..5).contains(&2));
assert!( (3..5).contains(&3));
assert!( (3..5).contains(&4));
assert!(!(3..5).contains(&5));

assert!(!(3..3).contains(&3));
assert!(!(3..2).contains(&3));

assert!( (0.0..1.0).contains(&0.5));
assert!(!(0.0..1.0).contains(&f32::NAN));
assert!(!(0.0..f32::NAN).contains(&0.5));
assert!(!(f32::NAN..1.0).contains(&0.5));

pub fn is_empty(&self) -> bool

Returns true if the range contains no items.

Examples

assert!(!(3..5).is_empty());
assert!( (3..3).is_empty());
assert!( (3..2).is_empty());

The range is empty if either side is incomparable:

assert!(!(3.0..5.0).is_empty());
assert!( (3.0..f32::NAN).is_empty());
assert!( (f32::NAN..5.0).is_empty());

Trait Implementations

impl Clone for SourceRange

fn clone(&self) -> SourceRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceRange

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

Formats the value using the given formatter.

impl Deref for SourceRange

type Target = Range<usize>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.