Trait Endpoint

pub trait Endpoint {
    type Request: Schema;
    type Response: Schema;

    const PATH: &'static str;
    const REQ_KEY: Key;
    const RESP_KEY: Key;
    const REQ_KEY4: Key4 = _;
    const REQ_KEY2: Key2 = _;
    const REQ_KEY1: Key1 = _;
    const RESP_KEY4: Key4 = _;
    const RESP_KEY2: Key2 = _;
    const RESP_KEY1: Key1 = _;
}

A marker trait denoting a single endpoint

Typically used with the endpoint macro.

Required Associated Constants

const PATH: &'static str

The path associated with this Endpoint

const REQ_KEY: Key

The unique Key identifying the Request

const RESP_KEY: Key

The unique Key identifying the Response

Provided Associated Constants

const REQ_KEY4: Key4 = _

The unique Key4 identifying the Request

const REQ_KEY2: Key2 = _

The unique Key2 identifying the Request

const REQ_KEY1: Key1 = _

The unique Key1 identifying the Request

const RESP_KEY4: Key4 = _

The unique Key4 identifying the Response

const RESP_KEY2: Key2 = _

The unique Key2 identifying the Response

const RESP_KEY1: Key1 = _

The unique Key1 identifying the Response

Required Associated Types

type Request: Schema

The type of the Request (client to server)

type Response: Schema

The type of the Response (server to client)

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Endpoint for GetAllSchemasEndpoint

const PATH: &'static str = "postcard-rpc/schemas/get"

const REQ_KEY: Key

const RESP_KEY: Key

type Request = ()

type Response = SchemaTotals

impl Endpoint for PingEndpoint

const PATH: &'static str = "postcard-rpc/ping"

const REQ_KEY: Key

const RESP_KEY: Key

type Request = u32

type Response = u32