Struct jsdoc::Input

pub struct Input<'i> { /* fields omitted */ }

Implementations

impl<'i> Input<'i>

pub const fn empty() -> Self

pub const fn new(start: BytePos, end: BytePos, src: &'i str) -> Self

pub fn span(self) -> Span

Trait Implementations

impl<'i> Clone for Input<'i>

fn clone(&self) -> Input<'i>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Compare<&'a str> for Input<'_>

fn compare(&self, t: &'a str) -> CompareResult

compares self to another value for equality

fn compare_no_case(&self, t: &'a str) -> CompareResult

compares self to another value for equality independently of the case.

impl<'i> Debug for Input<'i>

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

Formats the value using the given formatter.

impl Deref for Input<'_>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, 'b> From<&'a Comment> for Input<'a>

fn from(c: &'a Comment) -> Self

Performs the conversion.

impl<'i> From<Input<'i>> for Text

fn from(i: Input<'_>) -> Self

Performs the conversion.

impl<'a> InputIter for Input<'a>

type Item = char

the current input type is a sequence of that Item type.

type Iter = CharIndices<'a>

an iterator over the input type, producing the item and its position for use with Slice. If we’re iterating over &str, the position corresponds to the byte index of the character

type IterElem = Chars<'a>

an iterator over the input type, producing the item

fn iter_indices(&self) -> Self::Iter

returns an iterator over the elements and their byte offsets

fn iter_elements(&self) -> Self::IterElem

returns an iterator over the elements

fn position<P>(&self, predicate: P) -> Option<usize> where
    P: Fn(Self::Item) -> bool, 

finds the byte position of the element

fn slice_index(&self, count: usize) -> Option<usize>

get the byte offset from the element’s position in the stream

impl InputLength for Input<'_>

fn input_len(&self) -> usize

calculates the input length, as indicated by its name, and the name of the trait itself

impl InputTake for Input<'_>

fn take(&self, count: usize) -> Self

returns a slice of count bytes. panics if count > length

fn take_split(&self, count: usize) -> (Self, Self)

split the stream at the count byte offset. panics if count > length

impl Slice<Range<usize>> for Input<'_>

fn slice(&self, range: Range<usize>) -> Self

slices self according to the range argument

impl Slice<RangeFrom<usize>> for Input<'_>

fn slice(&self, range: RangeFrom<usize>) -> Self

slices self according to the range argument

impl Slice<RangeTo<usize>> for Input<'_>

fn slice(&self, range: RangeTo<usize>) -> Self

slices self according to the range argument

impl<'i> Copy for Input<'i>

impl UnspecializedInput for Input<'_>