Skip to main content

RefineConfig

Struct RefineConfig 

Source
#[non_exhaustive]
pub struct RefineConfig { pub enabled: bool, pub max_iterations: u8, pub min_improvement: f32, pub weights: RefineWeights, pub diagnosers: Vec<Arc<dyn Diagnoser>>, }
Expand description

Configuration for the retrospective refine pass on DocumentPlan::render.

RefineConfig::off() is the default and a no-op — engines without .refine(...) produce byte-identical output to the no-refine path.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§enabled: bool§max_iterations: u8§min_improvement: f32§weights: RefineWeights§diagnosers: Vec<Arc<dyn Diagnoser>>

Implementations§

Source§

impl RefineConfig

Source

pub fn off() -> Self

Disabled — render path is unchanged.

Source

pub fn balanced() -> Self

Default opt-in shape: 3 iterations, balanced weights, no built-in diagnosers attached yet (built-ins land in a follow-up commit).

Source

pub fn is_off(&self) -> bool

Source

pub fn with_max_iterations(self, n: u8) -> Self

Source

pub fn with_min_improvement(self, m: f32) -> Self

Source

pub fn with_weights(self, w: RefineWeights) -> Self

Source

pub fn with_diagnoser(self, d: Arc<dyn Diagnoser>) -> Self

Trait Implementations§

Source§

impl Clone for RefineConfig

Source§

fn clone(&self) -> RefineConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RefineConfig

Source§

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

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

impl Default for RefineConfig

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.