Struct CMarkReadme

pub struct CMarkReadme<P, M> { /* private fields */ }

Parsed readme Markdown with optionally specified package path and package manifest.

Implementations

impl<'a> CMarkReadme<&'a Path, &'a Manifest>

pub fn from_package( package: &'a Package, ) -> Result<Self, CMarkReadmeFromPackageError>

Creates readme from package.

It reads readme file by path specified in the package manifest.

impl CMarkReadme<(), ()>

pub fn from_file(file: Arc<File>) -> Self

Creates readme from file.

impl<'a, P, M> CMarkReadme<P, M>

pub fn with_package_path( self, package_path: &'a Package, ) -> CMarkReadme<&'a Package, M>

Adding the specified package path to the readme.

pub fn with_manifest( self, manifest: &'a Manifest, ) -> CMarkReadme<P, &'a Manifest>

Adding the specified manifest to the readme.

pub fn from_file_and_package_path_and_manifest( file: Arc<File>, package_path: P, manifest: M, ) -> Self

Creates readme from file, package path and manifest.

pub fn from_data_and_package_path_and_manifest( data: CMarkData, package_path: P, manifest: M, ) -> Self

Creates readme from CMark items, package path and manifest.

pub fn data(&self) -> &CMarkData

Returns CMark items.

pub fn into_data(self) -> CMarkData

Consumes the CMarkReadme, returning CMarkData.

pub fn package_path(&self) -> &P

Returns the package path.

pub fn manifest(&self) -> &M

Returns the manifest.

pub fn iter(&self) -> CMarkDataIter<'_>

Iterate over CMarkItems.

pub fn iter_events(&self) -> impl Iterator<Item = &Event<'_>>

Iterate over pulldown-cmark events.

pub fn concat_texts(self) -> CMarkReadme<P, M>

Concatenate adjacent text events.

Use this transformation if you deleted some nodes manually and want to merge the neighboring text nodes.

This transformation is always applied right after readme and docs parsing, because some text events remain ununited. For example Rust attribute parser generate seperate text events for every line of source code, and pulldown_cmark generate seperate text events for character entity reference.

pub fn remove_images_only_paragraph<F>(self, predicate: F) -> CMarkReadme<P, M>

where F: FnMut(&[&str]) -> bool,

Removes first paragraph that contains only images and image-links, if the specified predicate returns true when passing image urls to it.

pub fn remove_badges_paragraph(self) -> CMarkReadme<P, M>

Removes first paragraph that contains only badges.

pub fn remove_section(self, heading: &str, level: u32) -> Self

Remove section with the specified heading text and level and its subsections.

pub fn remove_codeblock_tag(self, tag: &str) -> CMarkReadme<P, M>

Remove the specified fenced code block tag.

pub fn remove_codeblock_tags(self, tags: &[&str]) -> CMarkReadme<P, M>

Remove the specified fenced code block tags.

pub fn remove_documentation_section(self) -> Self

Remove sections with heading Documentation and level 2.

pub fn disallow_absolute_blob_links( self, repository_url: &str, ) -> Result<CMarkReadme<P, M>, DisallowUrlsWithPrefixError>

Returns self if absolute blob links to the specified repository not found, otherwise returns an error.

pub fn use_absolute_blob_urls(self, repository_url: &str) -> CMarkReadme<P, M>

Convert all relative links into absolute ones using the repository url as the root address.

impl<'a, P> CMarkReadme<P, &'a Manifest>

pub fn disallow_absolute_repository_blob_links( self, ) -> Result<CMarkReadme<P, &'a Manifest>, DisallowAbsoluteRepositoryBlobLinksError>

Returns self if absolute blob links to the manifest repository not found, otherwise returns an error.

pub fn use_absolute_repository_blob_urls( self, ) -> Result<CMarkReadme<P, &'a Manifest>, UseAbsoluteRepositoryBlobUrlsError>

Convert all relative links into absolute ones using the manifest repository url as the root address.

Trait Implementations

impl<P: Clone, M: Clone> Clone for CMarkReadme<P, M>

fn clone(&self) -> CMarkReadme<P, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug, M: Debug> Debug for CMarkReadme<P, M>

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

Formats the value using the given formatter.

impl<P: Default, M: Default> Default for CMarkReadme<P, M>

fn default() -> CMarkReadme<P, M>

Returns the “default value” for a type.

impl<P: PartialEq, M: PartialEq> PartialEq for CMarkReadme<P, M>

fn eq(&self, other: &CMarkReadme<P, M>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P, M> StructuralPartialEq for CMarkReadme<P, M>