#[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 MessageFormatterMessage formatter used to produce the core error message text.
snippets: SnippetModeSnippet rendering mode.
Implementations§
Source§impl<'a> RenderOptions<'a>
impl<'a> RenderOptions<'a>
Sourcepub fn new(formatter: &'a dyn MessageFormatter) -> Self
pub fn new(formatter: &'a dyn MessageFormatter) -> Self
Construct render options with the given message formatter and default values
for all other fields.
Defaults:
snippets:SnippetMode::Auto
Trait Implementations§
Source§impl<'a> Clone for RenderOptions<'a>
impl<'a> Clone for RenderOptions<'a>
Source§fn clone(&self) -> RenderOptions<'a>
fn clone(&self) -> RenderOptions<'a>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<'a> Default for RenderOptions<'a>
impl<'a> Default for RenderOptions<'a>
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> 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
Mutably borrows from an owned value. Read more