Struct doc_chunks::markdown::PlainOverlay

source ·

pub struct PlainOverlay<'a> { /* private fields */ }

Expand description

A plain representation of cmark riddled chunk.

Implementations

source

impl<'a> PlainOverlay<'a>

source

pub fn extract_plain_with_mapping(
cmark: &str
) -> (String, IndexMap<Range, SourceRange>)

Ranges are mapped cmark reduced/plain -> raw.

source

pub fn erase_cmark(chunk: &'a CheckableChunk) -> Self

Create a common mark overlay based on the provided CheckableChunk reference.

source

pub fn find_spans(&self, condensed_range: Range) -> IndexMap<Range, Span>

Since most checkers will operate on the plain data, an indirection to map cmark reduced / plain back to raw ranges, which are then mapped back to Spans. The returned key Ranges are in the condensed domain.

source

pub fn as_str(&self) -> &str

Obtains a reference to the plain, cmark erased representation.

Trait Implementations

source

impl<'a> Clone for PlainOverlay<'a>

source

fn clone(&self) -> PlainOverlay<'a>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> Debug for PlainOverlay<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> Display for PlainOverlay<'a>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a> RefUnwindSafe for PlainOverlay<'a>

impl<'a> Send for PlainOverlay<'a>

impl<'a> Sync for PlainOverlay<'a>

impl<'a> Unpin for PlainOverlay<'a>

impl<'a> UnwindSafe for PlainOverlay<'a>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct doc_chunks::markdown::PlainOverlay

Implementations

impl<'a> PlainOverlay<'a>

pub fn extract_plain_with_mapping( cmark: &str) -> (String, IndexMap<Range, SourceRange>)

pub fn erase_cmark(chunk: &'a CheckableChunk) -> Self

pub fn find_spans(&self, condensed_range: Range) -> IndexMap<Range, Span>

pub fn as_str(&self) -> &str

Trait Implementations

impl<'a> Clone for PlainOverlay<'a>

fn clone(&self) -> PlainOverlay<'a>

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

impl<'a> Debug for PlainOverlay<'a>

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

impl<'a> Display for PlainOverlay<'a>

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for PlainOverlay<'a>

impl<'a> Send for PlainOverlay<'a>

impl<'a> Sync for PlainOverlay<'a>

impl<'a> Unpin for PlainOverlay<'a>

impl<'a> UnwindSafe for PlainOverlay<'a>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for Twhere T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn extract_plain_with_mapping(
cmark: &str
) -> (String, IndexMap<Range, SourceRange>)

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,