Struct terror::Builder

pub struct Builder { /* private fields */ }

A builder for Terror. Intended for one-time used, consumed after calling Builder::build.

Implementations

impl Builder

pub fn short_message(self, msg: String) -> Builder

Adds a short error message.

pub fn short_message_str(self, msg: &str) -> Builder

Adds a short error message.

pub fn error_code(self, code: String) -> Builder

Adds an error code.

pub fn error_code_str(self, code: &str) -> Builder

Adds an error code.

pub fn add_text_detail(self, name: String, value: String) -> Builder

Adds a text detail.

Examples

For instance,

use terror::{Builder, Terror};
let built = Terror::new(500, String::from("generic error"))
    .add_text_detail(String::from("object_name"), String::from("server"))
    .build();

… may be rendered into a JSON like below:

{
    "status" : 500,
    "message" : "generic error",
    "details" : {
        "object_name" : "server"
    }
}

pub fn add_text_detail_str_key(self, name: &str, value: String) -> Builder

A shorthand for Builder::add_text_detail, which allows to pass the key name as &str.

pub fn add_int_detail(self, name: String, value: i64) -> Builder

Adds a numeric detail.

Examples

For instance,

use terror::{Builder, Terror};
let built = Terror::new(500, String::from("generic error"))
    .add_int_detail(String::from("object_id"), 922i64)
    .build();

… may be rendered into a JSON like below:

{
    "status" : 500,
    "message" : "generic error",
    "details" : {
        "object_id" : 922
    }
}

pub fn add_int_detail_str_key(self, name: &str, value: i64) -> Builder

A shorthand for Builder::add_int_detail, which allows to pass the key name as &str.

pub fn add_bool_detail(self, name: String, value: bool) -> Builder

Adds a boolean detail.

Examples

For instance,

use terror::{Builder, Terror};
let built = Terror::new(500, String::from("generic error"))
    .add_bool_detail(String::from("object_up"), false)
    .build();

… may be rendered into a JSON like below:

{
    "status" : 500,
    "message" : "generic error",
    "details" : {
        "object_up" : false
    }
}

pub fn add_bool_detail_str_key(self, name: &str, value: bool) -> Builder

A shorthand for Builder::add_bool_detail, which allows to pass the key name as &str.

pub fn add_value_detail(self, name: String, value: Value) -> Builder

Adds an arbitrary object as detail. Requires to be passed as a pointer.

Examples

For instance,

use terror::{Builder, Terror};
use serde_json::{json, Value};

let built = Terror::new(500, String::from("generic error"))
    .add_value_detail(
        String::from("object"),
        Value::from(json!({
            "id" : 94i32,
            "name" : "server"
        }))
    )
    .build();

… may be rendered into a JSON like below:

{
    "status" : 500,
    "message" : "generic error",
    "details" : {
        "object" : {
            "id" : 94,
            "name" : "server"
        }
    }
}

pub fn add_value_detail_str_key(self, name: &str, value: Value) -> Builder

A shorthand for Builder::add_value_detail, which allows to pass the key name as &str.

pub fn reference(self) -> Builder

Instructs the builder to attach a reference to MDN page explaining the HTTP status code.

pub fn build(self) -> Terror

Concludes the configuration and produces a new Terror instance with all ownerships transferred, thus fully consuming self.