Struct SphinxBuilder

Source

pub struct SphinxBuilder { /* private fields */ }

Implementations§

Source §

impl SphinxBuilder

Source

pub fn new( config: BuildConfig, source_dir: PathBuf, output_dir: PathBuf, ) -> Result<Self>

Source

pub fn set_parallel_jobs(&mut self, jobs: usize)

Source

pub fn enable_incremental(&mut self)

Source

pub fn fresh_env(&self) -> Result<()>

Discard the saved environment before building (sphinx-build -E).

Source

pub fn add_warning(&self, warning: BuildWarning)

Add a warning to the collection

Source

pub fn add_error(&self, error: BuildErrorReport)

Add an error to the collection

Source

pub fn should_fail_on_warning(&self) -> bool

Check if warnings should be treated as errors

Source

pub async fn clean(&self) -> Result<()>

Source

pub async fn build(&self) -> Result<BuildStats>

Auto Trait Implementations§

§

impl !UnwindSafe for SphinxBuilder

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§