Struct EnvelopeFields 

pub struct EnvelopeFields {
    pub ok_field: String,
    pub format_field: String,
    pub content_field: String,
    pub meta_field: String,
}

Customisable field names used in the JSON envelope.

Override any field name to match your API conventions.

Examples

use scriba::envelope::EnvelopeFields;

let fields = EnvelopeFields {
    ok_field: "success".into(),
    format_field: "type".into(),
    content_field: "result".into(),
    meta_field: "context".into(),
};
assert_eq!(fields.ok_field, "success");

Fields

ok_field: String

Field name for the success flag (default: "ok").

format_field: String

Field name for the format name (default: "format").

content_field: String

Field name for the content payload (default: "content" for Flat, "data" for Nested).

meta_field: String

Field name for the metadata object (default: "meta").

Trait Implementations

impl Clone for EnvelopeFields

fn clone(&self) -> EnvelopeFields

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeFields

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

Formats the value using the given formatter.

impl Default for EnvelopeFields

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EnvelopeFields

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

impl StructuralPartialEq for EnvelopeFields