Struct Profile 

pub struct Profile<'a> {
    pub narrative: Cow<'a, str>,
    pub ignore_line_postfix: Cow<'a, str>,
    pub ignored_block_start: Cow<'a, str>,
    pub ignored_block_end: Cow<'a, str>,
    pub indent: Cow<'a, str>,
}

A configuration for document extraction.

Fields

narrative: Cow<'a, str>

Introduces a narrative comment.

ignore_line_postfix: Cow<'a, str>

If a line of code ends with this, do not include it the output.

ignored_block_start: Cow<'a, str>

Starts a block of lines, all of which will be ignored until ignored_block_end.

ignored_block_end: Cow<'a, str>

Ends an ignored block.

indent: Cow<'a, str>

Sets the additional indentation for all following code blocks.

Implementations

impl<'a> Profile<'a>

pub fn from_comment(comment: &str) -> Self

Create a profile from a line comment string.

For instance, if in your language’s line comments start with ~~~, you can quickly create a standard profile for it like so:

let profile = Profile::from_comment("~~~");
assert_eq!(profile.narrative, "~~~:");
assert_eq!(profile.ignore_line_postfix, "~~~");
assert_eq!(profile.ignored_block_start, "~~~{");
assert_eq!(profile.ignored_block_end, "~~~}");
assert_eq!(profile.indent, "~~~>");

If you need more customization, use the various with_* builder methods.

pub fn with_narrative(self, s: impl Into<Cow<'a, str>>) -> Self

pub fn with_ignore_line_postfix(self, s: impl Into<Cow<'a, str>>) -> Self

pub fn with_ignored_block_start(self, s: impl Into<Cow<'a, str>>) -> Self

pub fn with_ignored_block_end(self, s: impl Into<Cow<'a, str>>) -> Self

pub fn with_indent(self, s: impl Into<Cow<'a, str>>) -> Self

Trait Implementations

impl<'a> Clone for Profile<'a>

fn clone(&self) -> Profile<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Profile<'a>

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

Formats the value using the given formatter.

impl Default for Profile<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Hash for Profile<'a>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Profile<'a>

fn eq(&self, other: &Profile<'a>) -> 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<'a> Eq for Profile<'a>

impl<'a> StructuralPartialEq for Profile<'a>