Struct conjure_error::serializable_error::Builder

pub struct Builder { /* private fields */ }

A builder for the SerializableError type.

Implementations

impl Builder

pub fn error_code(&mut self, error_code: ErrorCode) -> &mut Self

The broad category of the error.

When transmitted over HTTP, this determines the response’s status code.

Required.

pub fn error_name<T>(&mut self, error_name: T) -> &mut Self

where T: Into<String>,

The error’s name.

The name is made up of a namespace and more specific error name, separated by a :.

Required.

pub fn error_instance_id(&mut self, error_instance_id: Uuid) -> &mut Self

A unique identifier for this error instance.

This can be used to correlate reporting about the error as it transfers between components of a distributed system.

Required.

pub fn parameters<T>(&mut self, parameters: T) -> &mut Self

where T: IntoIterator<Item = (String, String)>,

Parameters providing more information about the error.

pub fn extend_parameters<T>(&mut self, parameters: T) -> &mut Self

where T: IntoIterator<Item = (String, String)>,

Parameters providing more information about the error.

pub fn insert_parameters<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<String>, V: Into<String>,

Parameters providing more information about the error.

pub fn build(&self) -> SerializableError

Constructs a new instance of the type.

Panics

Panics if a required field was not set.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl From<SerializableError> for Builder

fn from(_v: SerializableError) -> Builder

Converts to this type from the input type.