Struct ResponseConfiguration 

#[non_exhaustive]
pub struct ResponseConfiguration {
    pub result_path: String,
    pub error_path: Option<String>,
}

Configuration that defines how to parse JSON responses from REST API calls, including paths to result data and error information.

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.

result_path: String

The JSON path expression that identifies where the actual result data is located within the API response.

error_path: Option<String>

The JSON path expression that identifies where error information is located within API responses when requests fail.

Implementations

impl ResponseConfiguration

pub fn result_path(&self) -> &str

The JSON path expression that identifies where the actual result data is located within the API response.

pub fn error_path(&self) -> Option<&str>

The JSON path expression that identifies where error information is located within API responses when requests fail.

impl ResponseConfiguration

pub fn builder() -> ResponseConfigurationBuilder

Creates a new builder-style object to manufacture ResponseConfiguration.

Trait Implementations

impl Clone for ResponseConfiguration

fn clone(&self) -> ResponseConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseConfiguration

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

Formats the value using the given formatter.

impl PartialEq for ResponseConfiguration

fn eq(&self, other: &ResponseConfiguration) -> 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 StructuralPartialEq for ResponseConfiguration