Struct readme_sync::FileDocs

pub struct FileDocs { /* fields omitted */ }

Parsed .rs file documentation.

Implementations

impl FileDocs

pub fn from_file(
    file: Arc<File>,
    config: &Config<'_>
) -> Result<Self, FileDocsFromFileError>

Creates file documentations from the specified file with the specified features.

pub fn file(&self) -> &Arc<File>

Returns file file.

pub fn docs(&self) -> &str

Returns file docs.

pub fn remap(&self) -> &[TextRemap]

Returns file remap.

pub fn remap_to_file(&self, range: Range<usize>) -> Option<Range<usize>>

Remaps range from parsed documentation to source file content.

Trait Implementations

impl Clone for FileDocs

pub fn clone(&self) -> FileDocs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDocs

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

Formats the value using the given formatter.

impl Eq for FileDocs

impl Hash for FileDocs

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<FileDocs> for FileDocs

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

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

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

This method tests for !=.

impl StructuralEq for FileDocs

impl StructuralPartialEq for FileDocs