Struct doc_chunks::cluster::Clusters

source ·

pub struct Clusters { /* private fields */ }

Expand description

Cluster comments together, such they appear as continuous text blocks.

Implementations

source

impl Clusters

source

pub fn parse_token_tree(
 &mut self,
 source: &str,
 stream: TokenStream
) -> Result<()>

Helper function to parse a stream and associate the found literals.

source

pub fn load_from_str(
 source: &str,
 doc_comments: bool,
 dev_comments: bool
) -> Result<Self>

Load clusters from a &str. Optionally loads developer comments as well.

Trait Implementations

source

impl Debug for Clusters

source

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

Formats the value using the given formatter. Read more

source

impl From<Clusters> for Vec<CheckableChunk>

Convert the clusters of one file into a source description as well as well as vector of checkable chunks.

source

fn from(clusters: Clusters) -> Vec<CheckableChunk> ⓘ

Converts to this type from the input type.

Auto Trait Implementations

impl RefUnwindSafe for Clusters

impl Send for Clusters

impl Sync for Clusters

impl Unpin for Clusters

impl UnwindSafe for Clusters

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, 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::cluster::Clusters

Implementations

impl Clusters

pub fn parse_token_tree(
    &mut self,
    source: &str,
    stream: TokenStream
) -> Result<()>

pub fn load_from_str(
    source: &str,
    doc_comments: bool,
    dev_comments: bool
) -> Result<Self>

Trait Implementations

impl Debug for Clusters

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

impl From<Clusters> for Vec<CheckableChunk>

fn from(clusters: Clusters) -> Vec<CheckableChunk> ⓘ

Auto Trait Implementations

impl RefUnwindSafe for Clusters

impl Send for Clusters

impl Sync for Clusters

impl Unpin for Clusters

impl UnwindSafe for Clusters

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, 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>

Struct doc_chunks::cluster::Clusters

Implementations

impl Clusters

pub fn parse_token_tree( &mut self, source: &str, stream: TokenStream) -> Result<()>

pub fn load_from_str( source: &str, doc_comments: bool, dev_comments: bool) -> Result<Self>

Trait Implementations

impl Debug for Clusters

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

impl From<Clusters> for Vec<CheckableChunk>

fn from(clusters: Clusters) -> Vec<CheckableChunk> ⓘ

Auto Trait Implementations

impl RefUnwindSafe for Clusters

impl Send for Clusters

impl Sync for Clusters

impl Unpin for Clusters

impl UnwindSafe for Clusters

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, 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 parse_token_tree(
&mut self,
source: &str,
stream: TokenStream
) -> Result<()>

pub fn load_from_str(
source: &str,
doc_comments: bool,
dev_comments: bool
) -> Result<Self>

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, U> TryFrom<U> for Twhere
U: Into<T>,

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