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) -> Self

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

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

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

Source§

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

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

impl Display for RemoteError

Source§

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

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

Source§

fn from(e: RemoteError) -> Self

Converts to this type from the input type.
Source§

impl Hash for RemoteError

Source§

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

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

Source§

fn eq(&self, other: &Self) -> 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::Ok, __S::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<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> 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> MaybeSend for T
where T: Send,

Source§

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

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.