pub struct RenderOptions { /* private fields */ }Expand description
Deterministic document rendering options.
Implementations§
Source§impl RenderOptions
impl RenderOptions
Sourcepub const fn new(color: ColorMode) -> Self
pub const fn new(color: ColorMode) -> Self
Build options with automatic terminal width, a one-column buffer, and
DEFAULT_COLUMN_BUFFER_ENV as the operator override.
Sourcepub const fn record_style(self, style: RecordStyle) -> Self
pub const fn record_style(self, style: RecordStyle) -> Self
Frame Fields records in style.
Sourcepub const fn list_style(self, style: ListStyle) -> Self
pub const fn list_style(self, style: ListStyle) -> Self
Frame Table lists in style.
Sourcepub const fn row_separation(self, separation: RowSeparation) -> Self
pub const fn row_separation(self, separation: RowSeparation) -> Self
Separate Table rows with separation.
Sourcepub const fn record(self) -> RecordStyle
pub const fn record(self) -> RecordStyle
Record framing.
Sourcepub const fn separation(self) -> RowSeparation
pub const fn separation(self) -> RowSeparation
Row separation.
Sourcepub const fn width(self, width: u16) -> Self
pub const fn width(self, width: u16) -> Self
Force an explicit width. Tests and redirected renderers should use this.
Sourcepub const fn automatic_width_buffer(self, columns: u16) -> Self
pub const fn automatic_width_buffer(self, columns: u16) -> Self
Override the automatic-width buffer. Zero explicitly disables it.
Explicit Self::width remains exact regardless of this value.
Sourcepub const fn automatic_width_buffer_envs(
self,
names: &'static [&'static str],
) -> Self
pub const fn automatic_width_buffer_envs( self, names: &'static [&'static str], ) -> Self
Replace the ordered environment names used to configure the buffer. Pass aliases in precedence order or an empty slice to disable lookup.
Sourcepub const fn minimum_automatic_width(self, columns: u16) -> Self
pub const fn minimum_automatic_width(self, columns: u16) -> Self
Set the floor for automatically detected effective widths.
Sourcepub const fn explicit_width(self) -> Option<u16>
pub const fn explicit_width(self) -> Option<u16>
Explicit width, when set.
Sourcepub const fn explicit_automatic_width_buffer(self) -> Option<u16>
pub const fn explicit_automatic_width_buffer(self) -> Option<u16>
Explicit automatic-width buffer, when the library owner set one.
Sourcepub const fn automatic_width_buffer_env_names(self) -> &'static [&'static str]
pub const fn automatic_width_buffer_env_names(self) -> &'static [&'static str]
Ordered environment names used for the automatic-width buffer.
Sourcepub const fn automatic_width_minimum(self) -> u16
pub const fn automatic_width_minimum(self) -> u16
Floor applied only to automatically detected widths.
Trait Implementations§
Source§impl Clone for RenderOptions
impl Clone for RenderOptions
impl Copy for RenderOptions
Source§impl Debug for RenderOptions
impl Debug for RenderOptions
impl Eq for RenderOptions
Source§impl PartialEq for RenderOptions
impl PartialEq for RenderOptions
impl StructuralPartialEq for RenderOptions
Auto Trait Implementations§
impl Freeze for RenderOptions
impl RefUnwindSafe for RenderOptions
impl Send for RenderOptions
impl Sync for RenderOptions
impl Unpin for RenderOptions
impl UnsafeUnpin for RenderOptions
impl UnwindSafe for RenderOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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