Options

Struct Options 

Source
pub struct Options {
Show 13 fields pub cite: bool, pub latex: bool, pub no_follow: bool, pub space: bool, pub force_tex: bool, pub word: bool, pub src_loc: bool, pub show_pictures: bool, pub replace: bool, pub env_ignore: Vec<String>, pub include_list: Vec<String>, pub input_paths: Vec<String>, pub suppress_warnings: bool,
}
Expand description

Command-line options

Fields§

§cite: bool

Echo LaTeX \cite, \ref, and \pageref values

§latex: bool

Force LaTeX mode

§no_follow: bool

Do not follow \input and \include

§space: bool

Replace control sequences with space

§force_tex: bool

Force TeX mode (inhibit LaTeX mode)

§word: bool

Word-only output (one word per line)

§src_loc: bool

Output source location information

§show_pictures: bool

Show picture names

§replace: bool

Replace environments with “noun” for grammar checking

§env_ignore: Vec<String>

List of environments to ignore

§include_list: Vec<String>

List of includeonly files

§input_paths: Vec<String>

Input search paths

§suppress_warnings: bool

Suppress warnings

Implementations§

Source§

impl Options

Source

pub fn with_env_ignore(self, env_list: &str) -> Self

Create options with custom environment ignore list

Source

pub fn setup_input_paths(&mut self)

Set up input paths from environment or defaults

Source

pub fn is_latex(&self) -> bool

Check if we’re in LaTeX mode (latex flag set and not forced to tex)

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Options

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Options

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Options

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.