Skip to main content

OpDescriptor

Struct OpDescriptor 

Source
pub struct OpDescriptor {
    pub op_id: &'static str,
    pub kind: OpKind,
    pub input_ty: &'static str,
    pub output_ty: &'static str,
    pub idempotent_by_default: bool,
    pub auth_required: bool,
}
Expand description

Wire-shape of a single op in a transport rpc schema. See docs/design/rpc-transport.md for the full design — in short, an op is the dispatch unit shared by every RPC binding (HTTP unary, HTTP batch, HTTP stream, WebSocket). The macro emits one OpDescriptor per CRUD verb and per procedure when Schema.transport == TransportStyle::Rpc.

REST schemas continue to emit RouteTransportDescriptor instead; nothing emits both.

Fields§

§op_id: &'static str

Stable dotted id, e.g. "model.User.list" or "procedure.publishPost". This is the only dispatch key — same string appears in URLs (POST /rpc/:op_id), in batch/WS Request.op fields, and in generated client SDK call sites.

§kind: OpKind§input_ty: &'static str

Schema-level name of the input type (e.g. "PublishPostInput"). Empty string when the op takes no input.

§output_ty: &'static str

Schema-level name of the output type. Empty string when the op returns nothing (e.g. delete with no echo).

§idempotent_by_default: bool

Whether the op can be safely retried without an idempotency key. True for reads and pure procedures; false for mutations.

§auth_required: bool

Trait Implementations§

Source§

impl Clone for OpDescriptor

Source§

fn clone(&self) -> OpDescriptor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for OpDescriptor

Source§

fn eq(&self, other: &OpDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for OpDescriptor

Source§

impl Eq for OpDescriptor

Source§

impl StructuralPartialEq for OpDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.