Struct doc_chunks::literalset::LiteralSet

source · [−]

pub struct LiteralSet {
    pub coverage: (usize, usize),
    /* private fields */
}

Expand description

A set of consecutive literals.

Provides means to render them as a code block

Fields

coverage: (usize, usize)

lines spanned (start, end) inclusive

Implementations

source

impl LiteralSet

source

pub fn from(literal: TrimmedLiteral) -> Self

Initiate a new set based on the first literal

source

pub fn add_adjacent(
&mut self,
literal: TrimmedLiteral
) -> Result<(), TrimmedLiteral>

Add a literal to a literal set, if the previous lines literal already exists.

Returns literal within the Err variant if not adjacent

source

pub fn literals<'x>(&'x self) -> Vec<&'x TrimmedLiteral>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

The set of trimmed literals that is covered.

source

pub fn len(&self) -> usize

The number of literals inside this set.

source

pub fn into_chunk(self) -> CheckableChunk

Convert to a checkable chunk.

Creates the map from content ranges to source spans.

Trait Implementations

source

impl Clone for LiteralSet

source

fn clone(&self) -> LiteralSet

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 LiteralSet

source

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

Formats the value using the given formatter. Read more

source

impl Default for LiteralSet

source

fn default() -> LiteralSet

Returns the “default value” for a type. Read more

source

impl<'s> Display for LiteralSet

source

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

Formats the value using the given formatter. Read more

source

impl Hash for LiteralSet

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<LiteralSet> for LiteralSet

source

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

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

source

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

This method tests for !=.

source

impl Eq for LiteralSet

source

impl StructuralEq for LiteralSet

source

impl StructuralPartialEq for LiteralSet

Auto Trait Implementations

impl RefUnwindSafe for LiteralSet

impl Send for LiteralSet

impl Sync for LiteralSet

impl Unpin for LiteralSet

impl UnwindSafe for LiteralSet

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> ToString for T where
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 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::literalset::LiteralSet

Fields

Implementations

impl LiteralSet

pub fn from(literal: TrimmedLiteral) -> Self

pub fn add_adjacent( &mut self, literal: TrimmedLiteral) -> Result<(), TrimmedLiteral>

pub fn literals<'x>(&'x self) -> Vec<&'x TrimmedLiteral>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn len(&self) -> usize

pub fn into_chunk(self) -> CheckableChunk

Trait Implementations

impl Clone for LiteralSet

fn clone(&self) -> LiteralSet

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

impl Debug for LiteralSet

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

impl Default for LiteralSet

fn default() -> LiteralSet

impl<'s> Display for LiteralSet

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

impl Hash for LiteralSet

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

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

impl PartialEq<LiteralSet> for LiteralSet

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

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

impl Eq for LiteralSet

impl StructuralEq for LiteralSet

impl StructuralPartialEq for LiteralSet

Auto Trait Implementations

impl RefUnwindSafe for LiteralSet

impl Send for LiteralSet

impl Sync for LiteralSet

impl Unpin for LiteralSet

impl UnwindSafe for LiteralSet

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> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

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>

pub fn add_adjacent(
&mut self,
literal: TrimmedLiteral
) -> Result<(), TrimmedLiteral>

pub fn literals<'x>(&'x self) -> Vec<&'x TrimmedLiteral>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

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

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> ToString for T where
T: Display + ?Sized,

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

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