Struct splinter::error::InternalError

pub struct InternalError { /* private fields */ }

An error which is returned for reasons internal to the function.

This error is produced when a failure occurred within the function but the failure is due to an internal implementation detail of the function. This generally means that there is no specific information which can be returned that would help the caller of the function recover or otherwise take action.

Implementations

impl InternalError

pub fn from_source(source: Box<dyn Error>) -> Self

Constructs a new InternalError from a specified source error.

The implementation of std::fmt::Display for this error will simply pass through the display of the source message unmodified.

Examples

use splinter::error::InternalError;

let io_err = std::io::Error::new(std::io::ErrorKind::Other, "io error");
let internal_error = InternalError::from_source(Box::new(io_err));
assert_eq!(format!("{}", internal_error), "io error");

pub fn from_source_with_message(source: Box<dyn Error>, message: String) -> Self

Constructs a new InternalError from a specified source error and message string.

The implementation of std::fmt::Display for this error will be the message string provided.

Examples

use splinter::error::InternalError;

let io_err = std::io::Error::new(std::io::ErrorKind::Other, "io error");
let internal_error = InternalError::from_source_with_message(Box::new(io_err), "oops".to_string());
assert_eq!(format!("{}", internal_error), "oops");

pub fn from_source_with_prefix(source: Box<dyn Error>, prefix: String) -> Self

Constructs a new InternalError from a specified source error and prefix string.

The implementation of std::fmt::Display for this error will be constructed from the prefix and source message’s display following the format of format!("{}: {}", prefix, source).

Examples

use splinter::error::InternalError;

let io_err = std::io::Error::new(std::io::ErrorKind::Other, "io error");
let internal_error = InternalError::from_source_with_prefix(Box::new(io_err), "Could not open file".to_string());
assert_eq!(format!("{}", internal_error), "Could not open file: io error");

pub fn with_message(message: String) -> Self

Constructs a new InternalError with a specified message string.

The implementation of std::fmt::Display for this error will be the message string provided.

Examples

use splinter::error::InternalError;

let internal_error = InternalError::with_message("oops".to_string());
assert_eq!(format!("{}", internal_error), "oops");

pub fn reduce_to_string(self) -> String

Reduces the InternalError to the display string

If the error includes a source, the debug format will be logged to provide information that may be lost on the conversion.

Trait Implementations

impl Debug for InternalError

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

Formats the value using the given formatter.

impl Display for InternalError

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

Formats the value using the given formatter.

impl Error for InternalError

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

impl From<InternalError> for AdminServiceStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for CredentialsStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for RoleBasedAuthorizationStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for KeyStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for OAuthUserSessionStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for UserProfileStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for RefreshTokenError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for NodeIdStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for OAuthClientBuildError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for InflightOAuthRequestStoreError

fn from(err: InternalError) -> Self

Converts to this type from the input type.

impl From<InternalError> for RegistryError

fn from(err: InternalError) -> Self

Converts to this type from the input type.