Skip to main content

DomainRejection

Struct DomainRejection 

Source
pub struct DomainRejection {
    pub code: RejectionCode,
    pub message_key: String,
    pub details: Box<Value>,
    pub explanation: Option<Box<LocalizedText>>,
    pub argument: Option<String>,
}
Expand description

A domain refused an act or a command (spec §8.2).

details is application-defined structured data for the UI; it must not be interpolated into logs.

Fields§

§code: RejectionCode

Stable machine-readable code.

§message_key: String

Key of the user-facing message in the application’s copy catalog.

§details: Box<Value>

Structured details (field names, limits…).

Boxed for the same reason Self::explanation is: a rejection travels in the Err half of every compile and validate call, so the size of the unhappy path is the size of every call’s return value. A JSON document is the largest thing here and the least often read.

§explanation: Option<Box<LocalizedText>>

Why, in words the user can read.

Self::message_key names copy in the application’s own catalog, which is the right shape when an application has one and no use to the runtime when it does not: composition has to write a sentence and cannot resolve a key it knows nothing about. So a rejection may carry its own copy, the way a receipt does.

When it does, the turn tells the user the act was refused and why. When it does not, the turn still says an act was refused, in the runtime’s own words, because the alternative is what this field was added to fix: an assistant that cannot report a failure says something unrelated instead, and the user concludes the write succeeded.

Boxed because a DomainRejection travels inside the Err half of every compile and validate call, and copy is much larger than a code: putting it inline widens the error variant that every one of those returns.

§argument: Option<String>

The argument the rejection is about, as a JSON Pointer into the act’s arguments.

Present, the value can be asked for again; absent, the act is refused as it stands.

Implementations§

Source§

impl DomainRejection

Source

pub fn new( code: impl Into<RejectionCode>, message_key: impl Into<String>, ) -> Self

Builds a rejection without details.

Source

pub fn with_details(self, details: Value) -> Self

Attaches structured details.

Source

pub fn on_argument(self, pointer: impl Into<String>) -> Self

Says the rejection is about one argument, which the user may give again.

Source

pub fn with_explanation(self, explanation: LocalizedText) -> Self

Attaches the sentence the user should read.

Write it the way you write a receipt’s body: server-authored copy, in the languages the workflow answers in. It reaches the user as a notice whether or not a model runs, and the narrator is shown it so its prose does not contradict what the notice says.

Trait Implementations§

Source§

impl Clone for DomainRejection

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 DomainRejection

Source§

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

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

impl<'de> Deserialize<'de> for DomainRejection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

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

impl Display for DomainRejection

Source§

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

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

impl Eq for DomainRejection

Source§

impl Error for DomainRejection

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<DomainRejection> for ErasedCallError

Source§

fn from(value: DomainRejection) -> Self

Converts to this type from the input type.
Source§

impl From<DomainRejection> for OrchestratorError

Source§

fn from(value: DomainRejection) -> Self

Converts to this type from the input type.
Source§

impl From<DomainRejection> for PlannedActResult

Source§

fn from(rejection: DomainRejection) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for DomainRejection

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 DomainRejection

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 DomainRejection

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

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, 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.