ErrorTemplate

Struct ErrorTemplate 

Source
pub struct ErrorTemplate<'a> { /* private fields */ }
Expand description

Parsed representation of an #[error("...")] template.

Templates are represented as a sequence of literal segments and placeholders. The structure mirrors the internal representation used by formatting machinery, but keeps the slices borrowed from the original input to avoid unnecessary allocations.

§Examples

use masterror_template::template::{ErrorTemplate, TemplateIdentifier};

let template = ErrorTemplate::parse("{code}: {message}").expect("parse");
let rendered = format!(
    "{}",
    template.display_with(|placeholder, f| match placeholder.identifier() {
        TemplateIdentifier::Named("code") => write!(f, "{}", 404),
        TemplateIdentifier::Named("message") => f.write_str("Not Found"),
        _ => Ok(())
    })
);

assert_eq!(rendered, "404: Not Found");

Implementations§

Source§

impl<'a> ErrorTemplate<'a>

Source

pub fn parse(source: &'a str) -> Result<Self, TemplateError>

Parses an error display template.

Source

pub const fn source(&self) -> &'a str

Returns the original template string.

Source

pub fn segments(&self) -> &[TemplateSegment<'a>]

Returns the parsed segments.

Source

pub fn placeholders(&self) -> impl Iterator<Item = &TemplatePlaceholder<'a>>

Iterates over placeholder segments in order of appearance.

Source

pub fn display_with<F>(&'a self, resolver: F) -> DisplayWith<'a, 'a, F>
where F: Fn(&TemplatePlaceholder<'a>, &mut Formatter<'_>) -> Result,

Produces a display implementation that delegates placeholder rendering to the provided resolver.

Trait Implementations§

Source§

impl<'a> Clone for ErrorTemplate<'a>

Source§

fn clone(&self) -> ErrorTemplate<'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> Debug for ErrorTemplate<'a>

Source§

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

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

impl<'a> PartialEq for ErrorTemplate<'a>

Source§

fn eq(&self, other: &ErrorTemplate<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> Eq for ErrorTemplate<'a>

Source§

impl<'a> StructuralPartialEq for ErrorTemplate<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ErrorTemplate<'a>

§

impl<'a> RefUnwindSafe for ErrorTemplate<'a>

§

impl<'a> Send for ErrorTemplate<'a>

§

impl<'a> Sync for ErrorTemplate<'a>

§

impl<'a> Unpin for ErrorTemplate<'a>

§

impl<'a> UnwindSafe for ErrorTemplate<'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.