Skip to main content

RenderOptions

Struct RenderOptions 

Source
#[non_exhaustive]
pub struct RenderOptions<'a> { pub formatter: &'a dyn MessageFormatter, pub snippets: SnippetMode, }
Expand description

Options for deferred error rendering.

Prefer constructing this via the render_options! macro instead of a struct literal. This keeps call sites stable even if new fields are added in the future (this type is #[non_exhaustive]).

§Example (using the render_options! macro)

use serde_saphyr::{DefaultMessageFormatter, SnippetMode};

let dev = DefaultMessageFormatter;
// Customize how an error is rendered later (formatter + snippet mode).
let render_opts = serde_saphyr::render_options! {
    formatter: &dev,
    snippets: SnippetMode::Off,
};

let err = serde_saphyr::from_str::<String>("").unwrap_err();
let rendered = err.render_with_options(render_opts);
assert!(rendered.contains("unexpected"));

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.
§formatter: &'a dyn MessageFormatter

Message formatter used to produce the core error message text.

§snippets: SnippetMode

Snippet rendering mode.

Implementations§

Source§

impl<'a> RenderOptions<'a>

Source

pub fn new(formatter: &'a dyn MessageFormatter) -> Self

Construct render options with the given message formatter and default values for all other fields.

Defaults:

Trait Implementations§

Source§

impl<'a> Clone for RenderOptions<'a>

Source§

fn clone(&self) -> RenderOptions<'a>

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<'a> Default for RenderOptions<'a>

Source§

fn default() -> Self

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

impl<'a> Copy for RenderOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for RenderOptions<'a>

§

impl<'a> !RefUnwindSafe for RenderOptions<'a>

§

impl<'a> !Send for RenderOptions<'a>

§

impl<'a> !Sync for RenderOptions<'a>

§

impl<'a> Unpin for RenderOptions<'a>

§

impl<'a> UnsafeUnpin for RenderOptions<'a>

§

impl<'a> !UnwindSafe for RenderOptions<'a>

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.