pub struct Error { /* private fields */ }Expand description
An error from reading or writing SOML.
A document that is not valid SOML, a document that does not fit the type it is read into, and a value that SOML cannot represent all give an Error. kind tells them apart. When the error is about a place in a document, it has a line and a column, and code_frame shows that place.
Messages replace terminal controls and bidirectional controls with U+FFFD. Tabs stay, and messages other than syntax errors may contain line feeds.
let error = soml::from_str::<soml::Value>("a: 1\na: 2").unwrap_err();
assert_eq!(error.kind(), soml::ErrorKind::Syntax);
assert_eq!(error.message(), "Duplicate key a");
assert_eq!(error.position(), Some(soml::LineColumn { line: 2, column: 1 }));
assert_eq!(error.to_string(), "Duplicate key a at line 2, column 1");Implementations§
Source§impl Error
impl Error
Sourcepub fn with_position(
message: impl Into<String>,
text: &str,
offset: usize,
) -> Self
pub fn with_position( message: impl Into<String>, text: &str, offset: usize, ) -> Self
An error of your own about a place in a document, such as a value that is valid SOML but not valid for your app. Use the byte offset of a Spanned value or of a syntax tree node. An offset past the end of text counts as its end. The error’s kind is ErrorKind::Data.
#[derive(serde::Deserialize)]
struct Server {
port: soml::Spanned<u16>,
}
let text = "# The server.\nport: 0";
let server: Server = soml::from_str(text)?;
if *server.port == 0 {
let start = server.port.span().unwrap().start;
let error = soml::Error::with_position("Port 0 is reserved", text, start);
assert_eq!(error.to_string(), "Port 0 is reserved at line 2, column 7");
}Sourcepub const fn position(&self) -> Option<LineColumn>
pub const fn position(&self) -> Option<LineColumn>
The line and column of the error, if it is about a place in a document.
Sourcepub const fn offset(&self) -> Option<usize>
pub const fn offset(&self) -> Option<usize>
The 0-based byte offset of the error in the document, if it is about a place in a document.
Sourcepub fn code_frame(&self, text: &str) -> Option<String>
pub fn code_frame(&self, text: &str) -> Option<String>
Up to three lines of text that end at the error, with a caret under its position, for a terminal. Give it the text the error came from. None when the error is not about a place in a document.
A long line is cut to a part around the position, and control characters, bidirectional controls, and other characters a terminal could act on are shown as U+FFFD. Tabs are kept, so the caret lines up whatever the tab width is. The layout is the same as the codeFrame of the JS reference implementation, except that a long line is cut by characters rather than by UTF-16 code units.
let text = "name: 'api'\nport: 80\nhost: localhost";
let error = soml::from_str::<soml::Value>(text).unwrap_err();
assert_eq!(error.code_frame(text).unwrap(), " 1 | name: 'api'\n 2 | port: 80\n> 3 | host: localhost\n | ^");For an error from from_slice about bytes that are not UTF-8, use String::from_utf8_lossy for the text: it matches the bytes up to the error.
Trait Implementations§
Source§impl Error for Error
impl Error for Error
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
Source§impl Error for Error
impl Error for Error
Source§fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self
fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self
Deserialize struct type received a field with an
unrecognized name.Source§fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self
fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self
Deserialize enum type received a variant with an
unrecognized name.Source§fn custom<T: Display>(message: T) -> Self
fn custom<T: Display>(message: T) -> Self
Source§fn invalid_type(unexpected: Unexpected<'_>, expected: &dyn Expected) -> Self
fn invalid_type(unexpected: Unexpected<'_>, expected: &dyn Expected) -> Self
Deserialize receives a type different from what it was
expecting. Read moreSource§fn invalid_value(unexpected: Unexpected<'_>, expected: &dyn Expected) -> Self
fn invalid_value(unexpected: Unexpected<'_>, expected: &dyn Expected) -> Self
Deserialize receives a value of the right type but that
is wrong for some other reason. Read moreSource§fn invalid_length(len: usize, exp: &dyn Expected) -> Self
fn invalid_length(len: usize, exp: &dyn Expected) -> Self
Source§fn missing_field(field: &'static str) -> Self
fn missing_field(field: &'static str) -> Self
Deserialize struct type expected to receive a required
field with a particular name but that field was not present in the
input.Source§fn duplicate_field(field: &'static str) -> Self
fn duplicate_field(field: &'static str) -> Self
Deserialize struct type received more than one of the
same field.