Skip to main content

RemoteError

Enum RemoteError 

Source
pub enum RemoteError {
    ActivationNotFound {
        activation: String,
    },
    MethodNotFound {
        activation: String,
        method: String,
    },
    InvalidParams {
        param: Option<String>,
        problem: ParamProblem,
    },
    Unauthenticated,
    Forbidden {
        reason: DenyReason,
    },
    HandleNotSupported {
        activation: String,
    },
    Execution {
        message: String,
    },
    TooManyCalls {
        max: u64,
        child: Option<String>,
    },
    ChildUnavailable {
        child: String,
        reason: String,
    },
    ChildTimeout {
        child: String,
        timeout_ms: u64,
    },
    Other(OtherError),
}
Expand description

Why a call failed — what an error frame carries, and the data of a JSON-RPC-level rejection.

Its JSON Schema is written by hand (see the JsonSchema impl): the known kinds as one kind-tagged union, KnownRemoteError, and any other kind as OtherError — the two as an untagged union of references, a form synapse’s IR reader takes (RETURNS-40), the wire unchanged.

Variants§

§

ActivationNotFound

The service has no activation by this name.

Fields

§activation: String
§

MethodNotFound

The activation exists but has no method by this name.

Fields

§activation: String
§method: String
§

InvalidParams

The call’s params did not fit the method.

Fields

§param: Option<String>

The parameter at fault, when the failure is about one.

§problem: ParamProblem

What is wrong with it. Flattened: its problem tag sits beside param on the wire.

§

Unauthenticated

The method requires credentials and the call carried none that verified.

§

Forbidden

The caller is authenticated but not allowed this call.

Fields

§reason: DenyReason

Which check the caller failed. Flattened: its reason tag sits beside kind on the wire.

§

HandleNotSupported

The activation does not resolve handles.

Fields

§activation: String
§

Execution

The method ran and failed for a reason that is not the activation saying no (that is an err item): a panic, a lost dependency.

Fields

§message: String
§

TooManyCalls

spec/05, 09: the connection — or the child the call was routed to — holds its maximum of open calls; close one and call again.

Fields

§max: u64

The most calls it holds open at once.

§child: Option<String>

The child whose limit it is, when the limit is a child’s.

§

ChildUnavailable

spec/12 rule 5: the child the call was routed to is not there.

Fields

§child: String
§reason: String
§

ChildTimeout

The child the call was routed to did not open it in the service’s time.

Fields

§child: String
§timeout_ms: u64
§

Other(OtherError)

A kind this build does not know, kept whole: its kind and every other field (RETURNS-36), written back as it came. Read only for a kind no known variant has (see the Deserialize impl).

Implementations§

Source§

impl RemoteError

Source

pub fn kind(&self) -> &str

The variant’s kind tag, as on the wire ("method_not_found", …) — for a log line or an exit code; match on the variant to handle it.

Trait Implementations§

Source§

impl Clone for RemoteError

Source§

fn clone(&self) -> RemoteError

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 Debug for RemoteError

Source§

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

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

impl<'de> Deserialize<'de> for RemoteError

Source§

fn deserialize<D>(d: D) -> Result<RemoteError, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for RemoteError

Source§

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

One line, for a human — what a CLI prints.

Source§

impl Eq for RemoteError

Source§

impl Error for RemoteError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<&PlexusError> for RemoteError

RETURNS-6: the server’s failure, as the wire carries it.

PlexusErrorRemoteError
ActivationNotFound(name)ActivationNotFound { activation: name }
MethodNotFound { activation, method }same
InvalidParams { param, problem }same
ExecutionError(msg)Execution { message: msg }
HandleNotSupported(ns)HandleNotSupported { activation: ns }
TransportError(kind) — a service forwarding upstream failedExecution { message: kind.to_string() }
Unauthenticated(_)Unauthenticated — the server-side reason stays server-side
Forbidden { reason }Forbidden { reason: DenyReason }

Forbidden renders at most the single fact the caller already failed (AUTHZ-CORE-1/5): MissingScope names the one unmet scope — the fact the 0.6 wire already carried in its Display line — and TenantBoundary / NotAccepted carry nothing.

Source§

fn from(e: &PlexusError) -> Self

Converts to this type from the input type.
Source§

impl From<Known> for RemoteError

Source§

fn from(k: Known) -> RemoteError

Converts to this type from the input type.
Source§

impl Hash for RemoteError

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl JsonSchema for RemoteError

Available on crate feature schema only.

The known kinds (KnownRemoteError) or any other (OtherError), as an untagged union of the two references — what synapse’s IR reader takes for an open union (RETURNS-40); a tagged union cannot hold a member whose kind is no const. The wire is RemoteError’s serde, unchanged.

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for RemoteError

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for RemoteError

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RemoteError

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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