Struct doc_chunks::span::Span

source · [−]

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

Expand description

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

source

impl Span

source

pub fn relative_to<X: Into>(&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.

source

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

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

source

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.

source

pub fn is_multiline(&self) -> bool

Check if self covers multiple lines

source

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

source

impl Clone for Span

source

fn clone(&self) -> Span

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

source

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

Formats the value using the given formatter. Read more

source

impl From<&'_ TrimmedLiteral> for Span

source

fn from(literal: &TrimmedLiteral) -> Self

Converts to this type from the input type.

source

impl From for Span

source

fn from(original: Span) -> Self

Converts to this type from the input type.

source

impl Hash for Span

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq for Span

source

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

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

source

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

This method tests for !=.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryInto<Range<usize>> for Span

type Error = Error

The type returned in the event of a conversion error.

source

fn try_into(self) -> Result<Range>

Performs the conversion.

source

impl TryInto<Range<usize>> for &Span

type Error = Error

The type returned in the event of a conversion error.

source

fn try_into(self) -> Result<Range>

Performs the conversion.

source

impl StructuralPartialEq for Span

Auto Trait Implementations

impl RefUnwindSafe for Span

impl Send for Span

impl Sync for Span

impl Unpin for Span

impl UnwindSafe for Span

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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 T where
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::()

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 T where
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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T, U> TryFrom for T where
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 T where
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::span::Span

Fields

Implementations

impl Span

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

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

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

pub fn is_multiline(&self) -> bool

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

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

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

impl Debug for Span

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

impl From<&'_ TrimmedLiteral> for Span

fn from(literal: &TrimmedLiteral) -> Self

impl From<Span> for Span

fn from(original: Span) -> Self

impl Hash for Span

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<Span> for Span

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

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

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

type Error = Error

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

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

type Error = Error

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

impl TryInto<Range<usize>> for Span

type Error = Error

fn try_into(self) -> Result<Range>

impl TryInto<Range<usize>> for &Span

type Error = Error

fn try_into(self) -> Result<Range>

impl Copy for Span

impl Eq for Span

impl StructuralEq for Span

impl StructuralPartialEq for Span

Auto Trait Implementations

impl RefUnwindSafe for Span

impl Send for Span

impl Sync for Span

impl Unpin for Span

impl UnwindSafe for Span

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

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 T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

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

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

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

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

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

impl<T> ToOwned for T where
T: Clone,

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

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