Struct ChatbotError 

pub struct ChatbotError {
    error_type: <ChatbotError as BackendError>::ErrorType,
    message: String,
    source: Option<Error>,
    span_trace: Box<SpanTrace>,
    backtrace: Box<Backtrace>,
    location: Option<&'static Location<'static>>,
    azure_source: Option<Box<ResponseError>>,
}

Error type used in ChatbotError, which is used for errors related to chatbot functionality.

All the information in the error is meant to be seen by the user. The type of error is determined by the ChatbotErrorType enum, which is stored inside this struct.

Examples

Usage without source error

if erroneous_condition {
    return Err(ChatbotError::new(
        ChatbotErrorType::Other,
        "File not found".to_string(),
        None,
    ));
}

Usage with a source error

Used when calling a function that returns an error that cannot be automatically converted to an ChatbotError. (See impl From<X> implementations on this struct.)

some_function_returning_an_error().map_err(|original_error| {
    ChatbotError::new(
        ChatbotErrorType::Other,
        "Library x failed to do y".to_string(),
        Some(original_error.into()),
    )
})?;

Fields

error_type: <ChatbotError as BackendError>::ErrorType

message: String

source: Option<Error>

Original error that caused this error.

span_trace: Box<SpanTrace>

A trace of tokio tracing spans, generated automatically when the error is generated.

backtrace: Box<Backtrace>

Stack trace, generated automatically when the error is created.

location: Option<&'static Location<'static>>

Source location where the error was raised.

azure_source: Option<Box<ResponseError>>

Implementations

impl ChatbotError

fn render_clean_error(&self, out: &mut dyn Write, color: ColorChoice) -> Result

pub fn clean_string(&self, color: ColorChoice) -> String

Render this error in the clean developer format.

impl ChatbotError

pub fn azure_source(&self) -> Option<AzureResponseError>

pub fn add_azure_source(&mut self, err: AzureResponseError)

Trait Implementations

impl BackendError for ChatbotError

type ErrorType = ChatbotErrorType

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

fn error_type(&self) -> &Self::ErrorType

fn message(&self) -> &str

fn span_trace(&self) -> &SpanTrace

fn location(&self) -> Option<&'static Location<'static>>

Source location where the error was raised, if captured.

fn new_with_traces_and_location<M: Into<String>, S: Into<Option<Error>>>( error_type: Self::ErrorType, message: M, source_error: S, backtrace: Backtrace, span_trace: SpanTrace, location: Option<&'static Location<'static>>, ) -> Self

The one required constructor; the others delegate to it.

fn new<M, S>(error_type: Self::ErrorType, message: M, source_error: S) -> Self

where M: Into<String>, S: Into<Option<Error>>, Self: Sized,

Create an error, capturing the caller’s location, a backtrace and the span trace.

fn new_with_traces<M, S>( error_type: Self::ErrorType, message: M, source_error: S, backtrace: Backtrace, span_trace: SpanTrace, ) -> Self

where M: Into<String>, S: Into<Option<Error>>, Self: Sized,

Like new but with an explicit backtrace and span trace, e.g. to preserve a source error’s traces.

fn to_different_error<T>( self, new_error_type: <T as BackendError>::ErrorType, new_message: String, ) -> T

where T: BackendError, Self: Sized + 'static + Send,

impl Debug for ChatbotError

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

Formats the value using the given formatter.

impl Display for ChatbotError

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

Formats the value using the given formatter.

impl Error for ChatbotError

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

Returns the lower-level source of this error, if any.

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for ChatbotError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ChatbotError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ChatbotError

fn from(err: Error) -> ChatbotError

Converts to this type from the input type.

impl From<Error> for ChatbotError

fn from(err: Error) -> ChatbotError

Converts to this type from the input type.

impl From<Error> for ChatbotError

fn from(err: Error) -> ChatbotError

Converts to this type from the input type.

impl From<ModelError> for ChatbotError

fn from(err: ModelError) -> ChatbotError

Converts to this type from the input type.

impl From<ParseError> for ChatbotError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<SearchFilterError> for ChatbotError

fn from(err: SearchFilterError) -> ChatbotError

Converts to this type from the input type.