Struct readme_sync::CMarkData

pub struct CMarkData(_);

A CMarkItems container storing a list of events with multiple transformation functions.

Implementations

impl CMarkData

pub fn from_items(items: Vec<Arc<CMarkItem>>) -> Self

Creates CMarkData from CMarkItems.

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

Creates CMarkData from the specified File.

pub fn from_file_docs(file_docs: Arc<FileDocs>) -> Self

Creates CMarkData from the specified FileDocs.

pub fn from_text_source(text_source: TextSource) -> Self

Creates CMarkData from the specified TextSource.

pub fn into_items(self) -> Vec<Arc<CMarkItem>>

Consumes the CMarkData, returning CMarkItems.

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) -> Self

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.

impl CMarkData

pub fn increment_heading_levels(self) -> Self

Increment levels of all headings.

In readme, the first level heading is usually used only for the project title. The second level header is usually used in for text section headings in readme. Rustdoc automatically adds the header of a crate name and the first level headers are used for text sections.

So it is necessary to increase the level of all headings in the documentation in order to synchronize the headings.

pub fn add_title(self, text: &str) -> Self

Add a first level heading with the specified text.

This function could be useful after heading level incremented.

pub fn remove_images_only_paragraph<P>(self, predicate: P) -> Self where
    P: 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) -> Self

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_documentation_section(self) -> Self

Remove sections with heading Documentation and level 2.

impl CMarkData

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

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

pub fn disallow_absolute_docs_links(
    self,
    package_name: &str,
    documentation_url: &str
) -> Result<Self, DisallowUrlsWithPrefixError>

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

pub fn disallow_urls_with_prefix(
    self,
    prefix: &str
) -> Result<Self, DisallowUrlsWithPrefixError>

Returns self if links with the specified prefix not found, otherwise returns an error.

pub fn use_absolute_blob_urls(self, repository_url: &str) -> Self

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

pub fn use_absolute_docs_urls(
    self,
    package_name: &str,
    documentation_url: &str
) -> Self

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

pub fn with_absolute_urls(self, prefix: &str) -> Self

Convert all relative links into absolute ones using specified url prefix.

pub fn map_links<F>(self, func: F, note: impl Into<Cow<'static, str>>) -> Self where
    for<'b> F: FnMut(&'b str) -> Cow<'b, str>, 

Converts all links with function func applied to each link address.

impl CMarkData

pub fn remove_codeblock_tag(self, tag: &str) -> Self

Remove the specified fenced code block tag.

pub fn remove_codeblock_tags(self, tags: &[&str]) -> Self

Remove the specified fenced code block tags.

impl CMarkData

pub fn remove_codeblock_rust_test_tags(self) -> Self

Remove fenced code block tags that are used by cargo test.

See https://doc.rust-lang.org/rustdoc/documentation-tests.html for more details.

pub fn use_default_codeblock_tag(self, tag: &str) -> Self

Use the specified codeblock tag, if they are not specified

impl CMarkData

pub fn use_default_codeblock_rust_tag(self) -> Self

Use rust fenced codeblock highlight as default.

pub fn remove_hidden_rust_code(self) -> Self

Remove hidden rust code from rust fenced codeblocks.

See https://doc.rust-lang.org/rustdoc/documentation-tests.html#hiding-portions-of-the-example for more details.

Trait Implementations

impl Clone for CMarkData

fn clone(&self) -> CMarkData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CMarkData

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

Formats the value using the given formatter.

impl Default for CMarkData

fn default() -> CMarkData

Returns the “default value” for a type.

impl PartialEq<CMarkData> for CMarkData

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

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

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

This method tests for !=.

impl StructuralPartialEq for CMarkData