Struct zerror_core::ErrorCore

pub struct ErrorCore { /* private fields */ }

ErrorCore implements 100% of Z for easy error reporting. It’s intended that people will wrap and proxy ErrorCore and then implement a short summary on top that descends from an error enum.

Implementations

impl ErrorCore

pub fn new(email: &str, short: &str, counter: &'static Counter) -> Self

Create a new ErrorCore with the provided email and short summary. The provided counter will be clicked each time a new error is created, to give people insight into the error. It’s advisable to have a separate counter for different conditions.

Trait Implementations

impl Clone for ErrorCore

fn clone(&self) -> ErrorCore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCore

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

Formats the value using the given formatter.

impl Default for ErrorCore

fn default() -> ErrorCore

Returns the “default value” for a type.

impl<'prototk> FieldPackHelper<'prototk, message<ErrorCore>> for ErrorCore

fn field_pack_sz(&self, tag: &Tag) -> usize

fn field_pack(&self, tag: &Tag, out: &mut [u8])

impl<'prototk> FieldUnpackHelper<'prototk, message<ErrorCore>> for ErrorCore

fn merge_field(&mut self, proto: message<ErrorCore>)

impl From<message<ErrorCore>> for ErrorCore

fn from(proto: message<ErrorCore>) -> Self

Converts to this type from the input type.

impl Packable for ErrorCore

fn pack_sz(&self) -> usize

pack_sz returns the number of bytes required to serialize the Packable object.

fn pack(&self, buf: &mut [u8])

pack fills in the buffer out with the packed binary representation of the Packable object. The implementor is responsible to ensure that out is exactly pack_sz() bytes and implementations are encouraged to assert this.

fn stream<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

stream writes the object to the provided writer using the same representation that would be used in a call to pack. The implementor is responsible for making sure that the number of bytes written is exactly equal to the number of required bytes.

impl<'prototk> Unpackable<'prototk> for ErrorCore

type Error = Error

fn unpack<'b>(buf: &'b [u8]) -> Result<(Self, &'b [u8]), Error>where 'b: 'prototk,

unpack attempts to return an Unpackable object stored in a prefix of buf. The method returns the result and remaining unused buffer.

impl Z for ErrorCore

type Error = ErrorCore

fn long_form(&self) -> String

Convert an error to a string free from “=”*80.

fn with_token(self, identifier: &str, value: &str) -> Self::Error

Add a token.

fn set_token(&mut self, identifier: &str, value: &str)

Add a token.

fn with_url(self, identifier: &str, url: &str) -> Self::Error

Add a URL.

fn set_url(&mut self, identifier: &str, url: &str)

Add a URL.

fn with_variable<X: Debug>(self, variable: &str, x: X) -> Self::Error

Add debug formatting of a local variable.

fn set_variable<X: Debug>(&mut self, variable: &str, x: X)

Add debug formatting of a local variable.

impl<'prototk> Message<'prototk> for ErrorCore