Struct ExternalMessage 

#[non_exhaustive]
pub struct ExternalMessage<'a> {
    pub source: ExternalMessageSource,
    pub original: &'a str,
    pub code: Option<&'a str>,
    pub params: &'a [(String, String)],
}

A best-effort description of an external message.

The crate should pass as much stable metadata as it has (e.g. code and params for validator) so the localizer can override specific messages without string matching.

Fields (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.

source: ExternalMessageSource

original: &'a str

The original text as provided by the external library.

code: Option<&'a str>

Stable-ish identifier when available (e.g. validator error code).

params: &'a [(String, String)]

Optional structured parameters when available.

Implementations

impl<'a> ExternalMessage<'a>

pub fn new(source: ExternalMessageSource, original: &'a str) -> Self

Construct an external message with no code or structured parameters.

pub fn with_code(self, code: &'a str) -> Self

Attach a dependency-provided message code.

pub fn with_params(self, params: &'a [(String, String)]) -> Self

Attach structured dependency-provided message parameters.

Trait Implementations

impl<'a> Clone for ExternalMessage<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ExternalMessage<'a>

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

Formats the value using the given formatter.