Enum InputJsonError 

pub enum InputJsonError {
    InternalServerError(InternalServerError),
    NotJson(NotJson),
    BadJson(BadJson),
}

Error type that may occur when working with user-provided JSON.

This error type figures out on its own whether the error is due to invalid JSON or JSON not matching the object we’re trying to deserialize. It will then use the underlying serde error to produce a nice error message, which points out exactly what in the user’s JSON string was invalid.

The main point of this type is that it provides From<serde_json::Error>. It should be used in a handler like this:

async fn room_account_data_set(
	account_data: Raw<AnyRoomAccountDataEventContent>,
) -> Result<
	ArminiusResponse<set_room_account_data::v3::Response>,
	InputJsonError,
> {
	let value: serde_json::Value =
		serde_json::to_value(account_data.into_json())
			.map_err(InputJsonError::from)?;

	/* Save the user data somehow */

	Ok(set_room_account_data::v3::Response::new().into())
}

Warning: This error type is meant to simplify the error handling for
user input, provided as part of the current request. If you use it
with data that was not provided by the user as part of this request, you
will risk returning “Bad Request” when the request is perfectly fine.
This means that you should not use this error type when processing
information that you have loaded from the database. If the database has
inconsistent data, that does not mean that the user has made a bad request.
You also risk creating security issues, by leaking information to the user
about data they would not have access to otherwise as part of the error.

Variants

InternalServerError(InternalServerError)

Error in JSON parsing, due to an IO error. This is not the users fault, so they don’t get to hear about it.

NotJson(NotJson)

The data the user provided is not correct JSON

BadJson(BadJson)

The JSON that the user provided cannot be deserialized into the requested datatype

Trait Implementations

impl Debug for InputJsonError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputJsonError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InputJsonError

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

Formats the value using the given formatter.

impl Error for InputJsonError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<Error> for InputJsonError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl IntoResponse for InputJsonError

fn into_response(self) -> Response

Create a response.

impl MatrixApiError for InputJsonError

fn create_matrix_error(&self) -> Error

Create a matrix error from the error

impl Serialize for InputJsonError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.