Skip to main content

Error

Struct Error 

Source
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

Source

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");
}
Source

pub const fn kind(&self) -> ErrorKind

What kind of problem the error is about.

Source

pub const fn message(&self) -> &str

What is wrong, without the position.

Source

pub const fn position(&self) -> Option<LineColumn>

The line and column of the error, if it is about a place in a document.

Source

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.

Source

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 Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl Error for Error

Source§

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.
Source§

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.
Source§

fn custom<T: Display>(message: T) -> Self

Raised when there is general error when deserializing a type. Read more
Source§

fn invalid_type(unexpected: Unexpected<'_>, expected: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting. Read more
Source§

fn invalid_value(unexpected: Unexpected<'_>, expected: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason. Read more
Source§

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements. Read more
Source§

fn missing_field(field: &'static str) -> Self

Raised when a 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

Raised when a Deserialize struct type received more than one of the same field.
Source§

impl Error for Error

Source§

fn custom<T: Display>(message: T) -> Self

Used when a Serialize implementation encounters any error while serializing a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.