Skip to main content

RpcSpec

Struct RpcSpec 

Source
pub struct RpcSpec {
    pub path: &'static str,
    pub service: &'static str,
    pub service_full: &'static str,
    pub method: &'static str,
    pub alias: &'static str,
    pub operation_kind: &'static str,
    pub read_only: bool,
    pub replay_safe: bool,
    pub client_streaming: bool,
    pub server_streaming: bool,
    pub http_method: &'static str,
    pub http_path: &'static str,
}
Expand description

One RPC, as the contract declares it.

Fields§

§path: &'static str

Full gRPC method path, e.g. /udb.services.v1.DataBroker/Select.

§service: &'static str

Service short name, e.g. DataBroker.

§service_full: &'static str

Fully-qualified service name, e.g. udb.services.v1.DataBroker.

§method: &'static str

Method name as it appears on the wire, e.g. Select.

§alias: &'static str

Snake-case alias used by the SDK surfaces.

§operation_kind: &'static str

Declared operation kind: read_only, mutation, or destructive.

§read_only: bool

True when the RPC performs no mutation.

§replay_safe: bool

True when the contract EXPLICITLY declares this mutation replayable (idempotency_contract). false also means “no contract declared”, which is why most read-only RPCs report false here. Do not read this alone before retrying — call RpcSpec::retry_safe.

§client_streaming: bool§server_streaming: bool§http_method: &'static str

REST verb and path from the google.api.http annotation, when annotated.

§http_path: &'static str

Implementations§

Source§

impl RpcSpec

Source

pub fn is_streaming(&self) -> bool

Whether this RPC streams in either direction.

Source

pub fn retry_safe(&self) -> bool

Whether repeating this call is safe.

TWO independent facts, and both matter:

  • read_only comes from operation_kind. A read applies no mutation, so repeating it is safe regardless of what else is declared.
  • replay_safe comes from an OPTIONAL idempotency_contract, and is false when that contract is simply absent. It marks the handful of MUTATIONS the broker guarantees are replayable.

Reading replay_safe alone would therefore treat “no contract declared” as “unsafe” and refuse to retry any read — the overwhelming majority of the surface. Consult this, not either field on its own.

Trait Implementations§

Source§

impl Clone for RpcSpec

Source§

fn clone(&self) -> RpcSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RpcSpec

Source§

impl Debug for RpcSpec

Source§

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

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

impl Eq for RpcSpec

Source§

impl PartialEq for RpcSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RpcSpec

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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 = !

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more