Struct doc_chunks::literal::TrimmedLiteral

pub struct TrimmedLiteral { /* private fields */ }

A literal with meta info where the first and list whitespace may be found.

Implementations

impl TrimmedLiteral

pub fn from(
    variant: CommentVariant,
    content: &str,
    pre: usize,
    post: usize,
    line: usize,
    column: usize
) -> Result<TrimmedLiteral, String>

Creates a new (single line) literal from the variant, the content, the size of the pre & post and the line/column on which it starts. Fails if provided with multiline content (i.e. if the content contains a line-break).

impl TrimmedLiteral

pub fn as_str(&self) -> &str

Represent the rendered content as str.

Does not contain pre and post characters.

pub fn prefix(&self) -> &str

The prefix characters.

pub fn suffix(&self) -> &str

The suffix characters.

pub fn as_untrimmed_str(&self) -> &str

Full representation including prefix and postfix characters.

pub fn len_in_chars(&self) -> usize

Length in characters, excluding pre and post.

pub fn len(&self) -> usize

Length in bytes, excluding pre and post.

pub fn pre(&self) -> usize

Obtain the number of characters in pre().

Since all pre characters are ASCII, this is equivalent to the number of bytes in pre().

pub fn post(&self) -> usize

Obtain the number of characters in post().

Since all pre characters are ASCII, this is equivalent to the number of bytes in post().

pub fn span(&self) -> Span

The span that is covered by this literal.

Covers only the content, no marker or helper characters.

pub fn chars<'a>(&'a self) -> impl Iterator<Item = char> + 'a

Access the characters via an iterator.

pub fn variant(&self) -> CommentVariant

The string variant type, see CommentVariant for details.

Trait Implementations

impl Clone for TrimmedLiteral

fn clone(&self) -> TrimmedLiteral

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrimmedLiteral

fn fmt(&self, formatter: &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 Hash for TrimmedLiteral

fn hash<H: Hasher>(&self, hasher: &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<TrimmedLiteral> for TrimmedLiteral

fn eq(&self, other: &Self) -> 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 Eq for TrimmedLiteral