Lines
97.83 %
Functions
58.39 %
Branches
100 %
use alloc::string::{String, ToString};
use core::{
fmt,
str::{self, Utf8Error},
};
use serde::{
de,
ser::{self, StdError},
use unicode_ident::is_xid_continue;
use crate::parse::{is_ident_first_char, is_ident_raw_char};
#[cfg(feature = "std")]
use std::io;
/// This type represents all possible errors that can occur when
/// serializing or deserializing RON data.
#[allow(clippy::module_name_repetitions)]
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SpannedError {
pub code: Error,
pub span: Span,
}
pub type Result<T, E = Error> = core::result::Result<T, E>;
pub type SpannedResult<T> = core::result::Result<T, SpannedError>;
#[non_exhaustive]
pub enum Error {
Fmt,
Io(String),
Message(String),
#[deprecated(
since = "0.9.0",
note = "ambiguous base64 byte strings are replaced by strongly typed Rusty b\"byte strings\""
)]
Base64Error(base64::DecodeError),
Eof,
ExpectedArray,
ExpectedArrayEnd,
ExpectedAttribute,
ExpectedAttributeEnd,
ExpectedBoolean,
ExpectedComma,
ExpectedChar,
ExpectedByteLiteral,
ExpectedFloat,
FloatUnderscore,
ExpectedInteger,
ExpectedOption,
ExpectedOptionEnd,
ExpectedMap,
ExpectedMapColon,
ExpectedMapEnd,
ExpectedDifferentStructName {
expected: &'static str,
found: String,
},
ExpectedStructLike,
ExpectedNamedStructLike(&'static str),
ExpectedStructLikeEnd,
ExpectedUnit,
ExpectedString,
ExpectedByteString,
ExpectedStringEnd,
ExpectedIdentifier,
InvalidEscape(&'static str),
IntegerOutOfBounds,
InvalidIntegerDigit {
digit: char,
base: u8,
NoSuchExtension(String),
UnclosedBlockComment,
UnclosedLineComment,
UnderscoreAtBeginning,
UnexpectedChar(char),
Utf8Error(Utf8Error),
TrailingCharacters,
InvalidValueForType {
expected: String,
ExpectedDifferentLength {
found: usize,
NoSuchEnumVariant {
expected: &'static [&'static str],
outer: Option<String>,
NoSuchStructField {
MissingStructField {
field: &'static str,
DuplicateStructField {
InvalidIdentifier(String),
SuggestRawIdentifier(String),
ExpectedRawValue,
ExceededRecursionLimit,
ExpectedStructName(String),
impl fmt::Display for SpannedError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}: {}", self.span, self.code)
impl fmt::Display for Error {
#[allow(clippy::too_many_lines)]
match *self {
Error::Fmt => f.write_str("Formatting RON failed"),
Error::Io(ref s) | Error::Message(ref s) => f.write_str(s),
#[allow(deprecated)]
Error::Base64Error(ref e) => write!(f, "Invalid base64: {}", e),
Error::Eof => f.write_str("Unexpected end of RON"),
Error::ExpectedArray => f.write_str("Expected opening `[`"),
Error::ExpectedArrayEnd => f.write_str("Expected closing `]`"),
Error::ExpectedAttribute => f.write_str("Expected an `#![enable(...)]` attribute"),
Error::ExpectedAttributeEnd => {
f.write_str("Expected closing `)]` after the enable attribute")
Error::ExpectedBoolean => f.write_str("Expected boolean"),
Error::ExpectedComma => f.write_str("Expected comma"),
Error::ExpectedChar => f.write_str("Expected char"),
Error::ExpectedByteLiteral => f.write_str("Expected byte literal"),
Error::ExpectedFloat => f.write_str("Expected float"),
Error::FloatUnderscore => f.write_str("Unexpected underscore in float"),
Error::ExpectedInteger => f.write_str("Expected integer"),
Error::ExpectedOption => f.write_str("Expected option"),
Error::ExpectedOptionEnd | Error::ExpectedStructLikeEnd => {
f.write_str("Expected closing `)`")
Error::ExpectedMap => f.write_str("Expected opening `{`"),
Error::ExpectedMapColon => f.write_str("Expected colon"),
Error::ExpectedMapEnd => f.write_str("Expected closing `}`"),
Error::ExpectedDifferentStructName {
expected,
ref found,
} => write!(
f,
"Expected struct {} but found {}",
Identifier(expected),
Identifier(found)
),
Error::ExpectedStructLike => f.write_str("Expected opening `(`"),
Error::ExpectedNamedStructLike(name) => {
if name.is_empty() {
f.write_str("Expected only opening `(`, no name, for un-nameable struct")
} else {
write!(f, "Expected opening `(` for struct {}", Identifier(name))
Error::ExpectedUnit => f.write_str("Expected unit"),
Error::ExpectedString => f.write_str("Expected string"),
Error::ExpectedByteString => f.write_str("Expected byte string"),
Error::ExpectedStringEnd => f.write_str("Expected end of string"),
Error::ExpectedIdentifier => f.write_str("Expected identifier"),
Error::InvalidEscape(s) => f.write_str(s),
Error::IntegerOutOfBounds => f.write_str("Integer is out of bounds"),
Error::InvalidIntegerDigit { digit, base } => {
write!(f, "Invalid digit {:?} for base {} integers", digit, base)
Error::NoSuchExtension(ref name) => {
write!(f, "No RON extension named {}", Identifier(name))
Error::Utf8Error(ref e) => fmt::Display::fmt(e, f),
Error::UnclosedBlockComment => f.write_str("Unclosed block comment"),
Error::UnclosedLineComment => f.write_str(
"`ron::value::RawValue` cannot end in unclosed line comment, \
try using a block comment or adding a newline",
Error::UnderscoreAtBeginning => {
f.write_str("Unexpected leading underscore in a number")
Error::UnexpectedChar(c) => write!(f, "Unexpected char {:?}", c),
Error::TrailingCharacters => f.write_str("Non-whitespace trailing characters"),
Error::InvalidValueForType {
ref expected,
} => {
write!(f, "Expected {} but found {} instead", expected, found)
Error::ExpectedDifferentLength {
found,
write!(f, "Expected {} but found ", expected)?;
match found {
0 => f.write_str("zero elements")?,
1 => f.write_str("one element")?,
n => write!(f, "{} elements", n)?,
f.write_str(" instead")
Error::NoSuchEnumVariant {
ref outer,
f.write_str("Unexpected ")?;
if outer.is_none() {
f.write_str("enum ")?;
write!(f, "variant named {}", Identifier(found))?;
if let Some(outer) = outer {
write!(f, " in enum {}", Identifier(outer))?;
write!(
", {}",
OneOf {
alts: expected,
none: "variants"
)
Error::NoSuchStructField {
write!(f, "Unexpected field named {}", Identifier(found))?;
write!(f, " in {}", Identifier(outer))?;
none: "fields"
Error::MissingStructField { field, ref outer } => {
write!(f, "Unexpected missing field named {}", Identifier(field))?;
match outer {
Some(outer) => write!(f, " in {}", Identifier(outer)),
None => Ok(()),
Error::DuplicateStructField { field, ref outer } => {
write!(f, "Unexpected duplicate field named {}", Identifier(field))?;
Error::InvalidIdentifier(ref invalid) => write!(f, "Invalid identifier {:?}", invalid),
Error::SuggestRawIdentifier(ref identifier) => write!(
"Found invalid std identifier {:?}, try the raw identifier `r#{}` instead",
identifier, identifier
Error::ExpectedRawValue => f.write_str("Expected a `ron::value::RawValue`"),
Error::ExceededRecursionLimit => f.write_str(
"Exceeded recursion limit, try increasing `ron::Options::recursion_limit` \
and using `serde_stacker` to protect against a stack overflow",
Error::ExpectedStructName(ref name) => write!(
"Expected the explicit struct name {}, but none was found",
Identifier(name)
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct Position {
pub line: usize,
pub col: usize,
impl Position {
pub(crate) fn from_src_end(src: &str) -> Position {
let line = 1 + src.chars().filter(|&c| c == '\n').count();
let col = 1 + src.chars().rev().take_while(|&c| c != '\n').count();
Self { line, col }
impl fmt::Display for Position {
write!(f, "{}:{}", self.line, self.col)
/// Spans select a range of text between two positions.
/// Spans are used in [`SpannedError`] to indicate the start and end positions
/// of the parser cursor before and after it encountered an error in parsing.
pub struct Span {
pub start: Position,
pub end: Position,
impl fmt::Display for Span {
if self.start == self.end {
write!(f, "{}", self.start)
write!(f, "{}-{}", self.start, self.end)
impl ser::Error for Error {
#[cold]
fn custom<T: fmt::Display>(msg: T) -> Self {
Error::Message(msg.to_string())
impl de::Error for Error {
fn invalid_type(unexp: de::Unexpected, exp: &dyn de::Expected) -> Self {
// Invalid type and invalid value are merged given their similarity in ron
Self::invalid_value(unexp, exp)
fn invalid_value(unexp: de::Unexpected, exp: &dyn de::Expected) -> Self {
struct UnexpectedSerdeTypeValue<'a>(de::Unexpected<'a>);
impl<'a> fmt::Display for UnexpectedSerdeTypeValue<'a> {
match self.0 {
de::Unexpected::Bool(b) => write!(f, "the boolean `{}`", b),
de::Unexpected::Unsigned(i) => write!(f, "the unsigned integer `{}`", i),
de::Unexpected::Signed(i) => write!(f, "the signed integer `{}`", i),
de::Unexpected::Float(n) => write!(f, "the floating point number `{}`", n),
de::Unexpected::Char(c) => write!(f, "the UTF-8 character `{}`", c),
de::Unexpected::Str(s) => write!(f, "the string {:?}", s),
de::Unexpected::Bytes(b) => write!(f, "the byte string b\"{}\"", {
b.iter()
.flat_map(|c| core::ascii::escape_default(*c))
.map(char::from)
.collect::<String>()
}),
de::Unexpected::Unit => write!(f, "a unit value"),
de::Unexpected::Option => write!(f, "an optional value"),
de::Unexpected::NewtypeStruct => write!(f, "a newtype struct"),
de::Unexpected::Seq => write!(f, "a sequence"),
de::Unexpected::Map => write!(f, "a map"),
de::Unexpected::Enum => write!(f, "an enum"),
de::Unexpected::UnitVariant => write!(f, "a unit variant"),
de::Unexpected::NewtypeVariant => write!(f, "a newtype variant"),
de::Unexpected::TupleVariant => write!(f, "a tuple variant"),
de::Unexpected::StructVariant => write!(f, "a struct variant"),
de::Unexpected::Other(other) => f.write_str(other),
expected: exp.to_string(),
found: UnexpectedSerdeTypeValue(unexp).to_string(),
fn invalid_length(len: usize, exp: &dyn de::Expected) -> Self {
found: len,
fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self {
found: variant.to_string(),
outer: None,
fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self {
found: field.to_string(),
fn missing_field(field: &'static str) -> Self {
Error::MissingStructField { field, outer: None }
fn duplicate_field(field: &'static str) -> Self {
Error::DuplicateStructField { field, outer: None }
impl StdError for SpannedError {}
impl StdError for Error {}
impl From<Utf8Error> for Error {
fn from(e: Utf8Error) -> Self {
Error::Utf8Error(e)
impl From<fmt::Error> for Error {
fn from(_: fmt::Error) -> Self {
Error::Fmt
impl From<io::Error> for Error {
fn from(e: io::Error) -> Self {
Error::Io(e.to_string())
impl From<SpannedError> for Error {
fn from(e: SpannedError) -> Self {
e.code
struct OneOf {
alts: &'static [&'static str],
none: &'static str,
impl fmt::Display for OneOf {
match self.alts {
[] => write!(f, "there are no {}", self.none),
[a1] => write!(f, "expected {} instead", Identifier(a1)),
[a1, a2] => write!(
"expected either {} or {} instead",
Identifier(a1),
Identifier(a2)
[a1, ref alts @ .., an] => {
write!(f, "expected one of {}", Identifier(a1))?;
for alt in alts {
write!(f, ", {}", Identifier(alt))?;
write!(f, ", or {} instead", Identifier(an))
struct Identifier<'a>(&'a str);
impl<'a> fmt::Display for Identifier<'a> {
if self.0.is_empty() || !self.0.chars().all(is_ident_raw_char) {
return write!(f, "{:?}_[invalid identifier]", self.0);
let mut chars = self.0.chars();
if !chars.next().map_or(false, is_ident_first_char) || !chars.all(is_xid_continue) {
write!(f, "`r#{}`", self.0)
write!(f, "`{}`", self.0)
#[cfg(test)]
mod tests {
use alloc::{format, string::String};
use serde::{de::Error as DeError, de::Unexpected, ser::Error as SerError};
use super::{Error, Position, Span, SpannedError};
#[test]
fn error_messages() {
check_error_message(&Error::from(core::fmt::Error), "Formatting RON failed");
check_error_message(
&Error::from(std::io::Error::new(
std::io::ErrorKind::InvalidData,
"my-error",
)),
);
check_error_message(&<Error as SerError>::custom("my-ser-error"), "my-ser-error");
check_error_message(&<Error as DeError>::custom("my-de-error"), "my-de-error");
&Error::Base64Error(base64::DecodeError::InvalidPadding),
"Invalid base64: Invalid padding",
check_error_message(&Error::Eof, "Unexpected end of RON");
check_error_message(&Error::ExpectedArray, "Expected opening `[`");
check_error_message(&Error::ExpectedArrayEnd, "Expected closing `]`");
&Error::ExpectedAttribute,
"Expected an `#![enable(...)]` attribute",
&Error::ExpectedAttributeEnd,
"Expected closing `)]` after the enable attribute",
check_error_message(&Error::ExpectedBoolean, "Expected boolean");
check_error_message(&Error::ExpectedComma, "Expected comma");
check_error_message(&Error::ExpectedChar, "Expected char");
check_error_message(&Error::ExpectedByteLiteral, "Expected byte literal");
check_error_message(&Error::ExpectedFloat, "Expected float");
check_error_message(&Error::FloatUnderscore, "Unexpected underscore in float");
check_error_message(&Error::ExpectedInteger, "Expected integer");
check_error_message(&Error::ExpectedOption, "Expected option");
check_error_message(&Error::ExpectedOptionEnd, "Expected closing `)`");
check_error_message(&Error::ExpectedStructLikeEnd, "Expected closing `)`");
check_error_message(&Error::ExpectedMap, "Expected opening `{`");
check_error_message(&Error::ExpectedMapColon, "Expected colon");
check_error_message(&Error::ExpectedMapEnd, "Expected closing `}`");
&Error::ExpectedDifferentStructName {
expected: "raw+identifier",
found: String::from("identifier"),
"Expected struct `r#raw+identifier` but found `identifier`",
check_error_message(&Error::ExpectedStructLike, "Expected opening `(`");
&Error::ExpectedNamedStructLike(""),
"Expected only opening `(`, no name, for un-nameable struct",
&Error::ExpectedNamedStructLike("_ident"),
"Expected opening `(` for struct `_ident`",
check_error_message(&Error::ExpectedUnit, "Expected unit");
check_error_message(&Error::ExpectedString, "Expected string");
check_error_message(&Error::ExpectedByteString, "Expected byte string");
check_error_message(&Error::ExpectedStringEnd, "Expected end of string");
check_error_message(&Error::ExpectedIdentifier, "Expected identifier");
check_error_message(&Error::InvalidEscape("Invalid escape"), "Invalid escape");
check_error_message(&Error::IntegerOutOfBounds, "Integer is out of bounds");
&Error::InvalidIntegerDigit {
digit: 'q',
base: 16,
"Invalid digit 'q' for base 16 integers",
&Error::NoSuchExtension(String::from("unknown")),
"No RON extension named `unknown`",
check_error_message(&Error::UnclosedBlockComment, "Unclosed block comment");
&Error::UnclosedLineComment,
&Error::UnderscoreAtBeginning,
"Unexpected leading underscore in a number",
check_error_message(&Error::UnexpectedChar('🦀'), "Unexpected char \'🦀\'");
#[allow(invalid_from_utf8)]
&Error::Utf8Error(core::str::from_utf8(b"error: \xff\xff\xff\xff").unwrap_err()),
"invalid utf-8 sequence of 1 bytes from index 7",
&Error::TrailingCharacters,
"Non-whitespace trailing characters",
&Error::invalid_value(Unexpected::Enum, &"struct `Hi`"),
"Expected struct `Hi` but found an enum instead",
&Error::invalid_length(0, &"two bees"),
"Expected two bees but found zero elements instead",
&Error::invalid_length(1, &"two bees"),
"Expected two bees but found one element instead",
&Error::invalid_length(3, &"two bees"),
"Expected two bees but found 3 elements instead",
&Error::unknown_variant("unknown", &[]),
"Unexpected enum variant named `unknown`, there are no variants",
&Error::NoSuchEnumVariant {
expected: &["A", "B+C"],
found: String::from("D"),
outer: Some(String::from("E")),
"Unexpected variant named `D` in enum `E`, \
expected either `A` or `r#B+C` instead",
&Error::unknown_field("unknown", &[]),
"Unexpected field named `unknown`, there are no fields",
&Error::NoSuchStructField {
expected: &["a"],
found: String::from("b"),
outer: Some(String::from("S")),
"Unexpected field named `b` in `S`, expected `a` instead",
expected: &["a", "b+c", "d"],
found: String::from("e"),
"Unexpected field named `e` in `S`, \
expected one of `a`, `r#b+c`, or `d` instead",
&Error::missing_field("a"),
"Unexpected missing field named `a`",
&Error::MissingStructField {
field: "",
outer: Some(String::from("S+T")),
"Unexpected missing field named \"\"_[invalid identifier] in `r#S+T`",
&Error::duplicate_field("a"),
"Unexpected duplicate field named `a`",
&Error::DuplicateStructField {
field: "b+c",
"Unexpected duplicate field named `r#b+c` in `r#S+T`",
&Error::InvalidIdentifier(String::from("why+🦀+not")),
"Invalid identifier \"why+🦀+not\"",
&Error::SuggestRawIdentifier(String::from("raw+ident")),
"Found invalid std identifier \"raw+ident\", \
try the raw identifier `r#raw+ident` instead",
&Error::ExpectedRawValue,
"Expected a `ron::value::RawValue`",
&Error::ExceededRecursionLimit,
&Error::ExpectedStructName(String::from("Struct")),
"Expected the explicit struct name `Struct`, but none was found",
fn check_error_message<T: core::fmt::Display>(err: &T, msg: &str) {
assert_eq!(format!("{}", err), msg);
fn spanned_error_into_code() {
assert_eq!(
Error::from(SpannedError {
code: Error::Eof,
span: Span {
start: Position { line: 1, col: 1 },
end: Position { line: 1, col: 5 },
Error::Eof
code: Error::ExpectedRawValue,
Error::ExpectedRawValue