Struct RunOptions 

pub struct RunOptions {
    pub link_pos: ReferencePlacement,
    pub footnote_pos: Option<ReferencePlacement>,
    pub link_format: LinkTransform,
    pub renumber_footnotes: bool,
    pub output: OutputFormat,
    pub wrap_width: Option<usize>,
    pub quiet: bool,
    pub allow_unknown_markdown: bool,
    pub add_breaks: Option<bool>,
    pub selectors: String,
    pub markdown_file_paths: Vec<String>,
}

Options analogous to the mdq CLI’s switches.

Fields

link_pos: ReferencePlacement

Where to put link references.

For links and images of style [description][1], this flag controls where to put the [1]: https://example.com definition.

footnote_pos: Option<ReferencePlacement>

Where to put footnote references. Defaults to be same as –link-pos

link_format: LinkTransform

renumber_footnotes: bool

output: OutputFormat

Specifies the output format. Defaults to markdown.

wrap_width: Option<usize>

The number of characters to wrap text at. This is only valid when the output format is markdown.

Certain elements (like section headings and link definitions) will never be wrapped, and the wrapping will never break a word; it will only ever be along existing whitespace. In particular, this means the wrapping will never add hyphens, and it will never break URLs.

quiet: bool

Quiet: do not print anything to stdout. The exit code will still be 0 if any elements match, and non-0 if none do.

allow_unknown_markdown: bool

add_breaks: Option<bool>

Include breaks between elements in plain and markdown output mode.

For plain, this will add a blank line between elements. For markdown, this will add a thematic break (“—–”) between elements.

This has no effect in JSON output mode.

This defaults to true for Markdown output, and false for plain text output.

This is analogous to the --[no-]br option in the CLI arguments.

selectors: String

The selectors string

markdown_file_paths: Vec<String>

An optional list of Markdown files to parse, by path. If not provided, standard input will be used.

If these are provided, mdq will act as if they were all concatenated into a single file. For example, if you use –link-pos=doc, the link definitions for all input files will be at the very end of the output.

A path of “-” represents standard input.

If these are provided, standard input will not be used unless one of the arguments is “-”. Files will be processed in the order you provide them. If you provide the same file twice, mdq will process it twice, unless that file is “-”; all but the first “-” paths are ignored.

Implementations

impl RunOptions

pub fn should_add_breaks(&self) -> bool

Trait Implementations

impl Clone for RunOptions

fn clone(&self) -> RunOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunOptions

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

Formats the value using the given formatter.

impl Default for RunOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&RunOptions> for MdWriterOptions

fn from(cli: &RunOptions) -> Self

Converts to this type from the input type.

impl Hash for RunOptions

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 Ord for RunOptions

fn cmp(&self, other: &RunOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RunOptions

fn eq(&self, other: &RunOptions) -> 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 PartialOrd for RunOptions

fn partial_cmp(&self, other: &RunOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RunOptions

impl StructuralPartialEq for RunOptions