Struct ruma_events::InvalidEvent

pub struct InvalidEvent(_);

An event that is malformed or otherwise invalid.

When attempting to create an event from a string of JSON data, an error in the input data may cause deserialization to fail, or the JSON structure may not corresponded to ruma-events's strict definition of the event's schema. If deserialization completely fails, this type will provide a message with details about the deserialization error. If deserialization succeeds but the event is otherwise invalid, a similar message will be provided, as well as a serde_json::Value containing the raw JSON data as it was deserialized.

Methods

impl InvalidEvent

pub fn message(&self) -> String

A message describing why the event is invalid.

pub fn json(&self) -> Option<&Value>

The raw serde_json::Value representation of the invalid event, if available.

Trait Implementations

impl From<Error> for InvalidEvent

fn from(error: Error) -> Self

Performs the conversion.

impl Display for InvalidEvent

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl Debug for InvalidEvent

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

Formats the value using the given formatter.

impl Error for InvalidEvent

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

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

The lower-level source of this error, if any.