Skip to main content

WriteError

Enum WriteError 

Source
#[non_exhaustive]
pub enum WriteError { Io(Error), Fmt, ExpectedKey, UnexpectedKey, MismatchedEnd, DocumentComplete, Incomplete, }
Expand description

Why a Writer call was refused.

The sequence errors (every variant but Io and Fmt) mean the calling code asked for something that is not JSON; the call wrote nothing and the writer is unchanged, so the caller may go on with a correct call. An output error finishes the writer: every later call fails too.

The enum is #[non_exhaustive].

§Examples

use jsonx_lib::{WriteError, Writer};

let mut out = String::new();
let mut w = Writer::new(&mut out);
w.begin_object()?;
assert!(matches!(w.value(&1), Err(WriteError::ExpectedKey)));
w.key("n")?;
w.value(&1)?;
w.end_object()?;
w.finish()?;
assert_eq!(out, r#"{"n":1}"#);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Io(Error)

Available on crate feature std only.

The io::Write failed. Its first error is returned once; later calls return an error of the same kind.

§

Fmt

The fmt::Write failed.

§

ExpectedKey

A value, or the start of an array or object, where an object member’s key belongs.

§

UnexpectedKey

A key outside an object, or a second key before the first one’s value.

§

MismatchedEnd

An end_array or end_object that does not close the innermost open container (or with none open, or with a key still waiting for its value).

§

DocumentComplete

A second top-level value: a document is one value.

§

Incomplete

finish before the document’s value was complete.

Trait Implementations§

Source§

impl Debug for WriteError

Source§

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

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

impl Display for WriteError

Source§

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

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

impl Error for WriteError

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

Auto Trait Implementations§

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.