Struct Reject 

#[non_exhaustive]
pub struct Reject {
    pub code: RejectCode,
    pub reason: String,
    pub details: String,
    pub policy: &'static str,
    pub scope: RejectScope,
}

Single rejection record returned by checks.

Examples

use openpit::pretrade::{Reject, RejectCode, RejectScope};

let reject = Reject::new(
    "RateLimitPolicy",
    RejectScope::Order,
    RejectCode::RateLimitExceeded,
    "rate limit exceeded",
    "submitted 3 orders in 1s window, max allowed: 2",
);
assert_eq!(reject.code, RejectCode::RateLimitExceeded);
assert_eq!(reject.reason, "rate limit exceeded");
assert_eq!(reject.details, "submitted 3 orders in 1s window, max allowed: 2");
assert_eq!(reject.policy, "RateLimitPolicy");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: RejectCode

Stable machine-readable reject code.

reason: String

Human-readable reject reason.

details: String

Case-specific reject details.

policy: &'static str

Policy name that produced the reject.

scope: RejectScope

Reject scope.

Implementations

impl Reject

pub fn new( policy: &'static str, scope: RejectScope, code: RejectCode, reason: impl Into<String>, details: impl Into<String>, ) -> Self

Creates a reject with human-readable reason and details.

Trait Implementations

impl Clone for Reject

fn clone(&self) -> Reject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reject

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

Formats the value using the given formatter.

impl Display for Reject

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

Formats the value using the given formatter.

impl Error for Reject

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl PartialEq for Reject

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Reject

impl StructuralPartialEq for Reject