Trait borked::BorkChain

pub trait BorkChain: 'static {
    fn chain(&mut self, cause: Box<dyn BorkChain>) -> &dyn BorkChain;
    fn name(&self) -> String;
    fn cause(&self) -> Option<&'static dyn BorkChain>;
    fn new() -> Option<Box<Self>>
    where
        Self: Sized + BorkChain;

    fn __private_get_type_id__(&self) -> TypeId { ... }
}

Main Bork Trait. See BaseBork for an example implementation.

Required methods

fn chain(&mut self, cause: Box<dyn BorkChain>) -> &dyn BorkChain

Used to store Bork within the Bork referenced by self. The stored Error is considered to be the cause of the referenced Error. The stored error can then be retrieved with the cause() fn.

fn name(&self) -> String

Get the name of the Error. This will be used to print the error.

fn cause(&self) -> Option<&'static dyn BorkChain>

Get the cause of the error. This is set either at Instantiation of the Error, or through the chain fn.

fn new() -> Option<Box<Self>> where
    Self: Sized + BorkChain, 

Return a new Instantiation. Return type is an option, so None can be returned if it is otherwise inconvienient to implement this. The other traits BorkWithMsg and/or BorkNoMsg can be implemented instead for a method that is not Optional.

Provided methods

fn __private_get_type_id__(&self) -> TypeId

Used for downcasting Borks to their underlying type.

Implementations

impl dyn BorkChain

Downcasting fn for BorkChain. Allows the original type of bork to be reconstructed.

pub fn downcast_ref<T: BorkChain>(&self) -> Option<&T>

This can be used to cast a BorkChain reference back to the concrete type that implements BorkChain.

Trait Implementations

impl Debug for dyn BorkChain

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

Formats the value using the given formatter.

impl Display for dyn BorkChain

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

Formats the value using the given formatter.

impl Error for dyn BorkChain

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Implementations on Foreign Types

impl BorkChain for Box<dyn BorkChain>

Allows Box to be treated as Bork

fn chain(&mut self, cause: Box<dyn BorkChain>) -> &dyn BorkChain

fn name(&self) -> String

fn new() -> Option<Box<Self>>

fn cause(&self) -> Option<&'static dyn BorkChain>

Implementors

impl<E: Error + 'static> BorkChain for E