Struct BrpRequest

pub struct BrpRequest {
    pub jsonrpc: String,
    pub method: String,
    pub id: Option<Value>,
    pub params: Option<Value>,
}

A single request from a Bevy Remote Protocol client to the server, serialized in JSON.

The JSON payload is expected to look like this:

{
    "jsonrpc": "2.0",
    "method": "bevy/get",
    "id": 0,
    "params": {
        "entity": 4294967298,
        "components": [
            "bevy_transform::components::transform::Transform"
        ]
    }
}

Or, to list all the fully-qualified type paths in your project, pass Null to the params.

{
   "jsonrpc": "2.0",
   "method": "bevy/list",
   "id": 0,
   "params": null
}

In Rust:

   let req = BrpRequest {
        jsonrpc: "2.0".to_string(),
        method: BRP_LIST_METHOD.to_string(), // All the methods have consts
        id: Some(ureq::json!(0)),
        params: None,
    };

Fields

jsonrpc: String

This field is mandatory and must be set to "2.0" for the request to be accepted.

method: String

The action to be performed.

id: Option<Value>

Arbitrary data that will be returned verbatim to the client as part of the response.

params: Option<Value>

The parameters, specific to each method.

These are passed as the first argument to the method handler. Sometimes params can be omitted.

Trait Implementations

impl Clone for BrpRequest

fn clone(&self) -> BrpRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BrpRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BrpRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BrpRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.