Enum cedar_policy::frontend::utils::InterfaceResult

pub enum InterfaceResult {
    Success {
        result: String,
    },
    Failure {
        is_internal: bool,
        errors: Vec<String>,
    },
}

Result of a call to a JSON interface

Variants

Success

The call succeeded

Fields

result: String

JSON containing the result of the call

Failure

The call failed

Fields

is_internal: bool

Whether the failure is “internal”.

An “internal failure” is returned when there is a fault in the Cedar Rust code, or when there is a problem with the request in the parts which the Java library is responsible for (e.g. an unsupported operation).

By contrast, a “bad request” is returned when there is an issue in the part of the request supplied by the ultimate user of the library, e.g. a syntax error in a policy.

errors: Vec<String>

String description of the error(s) that led to the failure

Implementations

impl InterfaceResult

pub fn succeed<T: Serialize>(value: T) -> Self

A successful result

pub fn fail_internally(message: String) -> Self

An “internal failure” result; see docs on InterfaceResult::Failure

pub fn fail_bad_request(errors: Vec<String>) -> Self

A failure result that isn’t internal; see docs on InterfaceResult::Failure

Trait Implementations

impl Debug for InterfaceResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InterfaceResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for InterfaceResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.