An error that occured while parsing or running an action. More...

#include <action.h>

Data Fields
action_error_type_t	type
	Type of the error.

union {

struct {

char const * location
	A human-friendly representation of the location of the error in the JSON request structure. More...

json_object * obj_actual
	The JSON object that is of the wrong type. More...

json_type expected
	The type obj_actual should have been of. More...

} type

struct {

char const * location
	A human-friendly representation of the location of the error in the JSON request structure, including the missing key. More...

} missing_key

struct {

char const * location
	A human-friendly representation of the location of the error in the JSON request structure. More...

char const * reason
	The reason why the value is invalid. More...

json_object * obj_bad
	The faulty JSON object. More...

} invalid

struct {

time_t next_request_at
	The Unix time at which the next request will be accepted. More...

} rate_limit

struct {

char const * name
	The name of the invariant that was broken. More...

} invariant

struct {

status_t status
	A status code for the error. More...

} other

}	info
	Payload of the action error, tagged by action_error_t::type.

Detailed Description

An error that occured while parsing or running an action.

Definition at line 43 of file action.h.

Field Documentation

◆ expected

json_type action_error_t::expected

The type obj_actual should have been of.

Definition at line 55 of file action.h.

◆ location

char const* action_error_t::location

A human-friendly representation of the location of the error in the JSON request structure.

A human-friendly representation of the location of the error in the JSON request structure, including the missing key.

Definition at line 50 of file action.h.

◆ name

char const* action_error_t::name

The name of the invariant that was broken.

Definition at line 75 of file action.h.

◆ next_request_at

time_t action_error_t::next_request_at

The Unix time at which the next request will be accepted.

Definition at line 71 of file action.h.

◆ obj_actual

json_object* action_error_t::obj_actual

The JSON object that is of the wrong type.

Note: Invariant: the type of this object is different from expected.

Definition at line 53 of file action.h.

◆ obj_bad

json_object* action_error_t::obj_bad

The faulty JSON object.

Definition at line 67 of file action.h.

◆ reason

char const* action_error_t::reason

The reason why the value is invalid.

Definition at line 65 of file action.h.

◆ status

status_t action_error_t::status

A status code for the error.

Definition at line 79 of file action.h.

◆ type

action_error_type_t action_error_t::type

Type of the error.

Definition at line 45 of file action.h.

The documentation for this struct was generated from the following file:

lib/tchatator413/action.h

Data Fields