Struct ProgramError 

pub struct ProgramError(/* private fields */);

Generic error type for RPC program implementations.

Wraps any thread-safe error for use by generated RPC service traits. Generated dispatchers map a returned ProgramError to RpcError::SystemError; the underlying error is not sent to the peer.

Example

use rpc_api::ProgramError;

fn load_config() -> Result<Vec<u8>, ProgramError> {
    let bytes = std::fs::read("config.bin")?;
    Ok(bytes)
}

Implementations

impl ProgramError

pub fn new<E>(err: E) -> Self

where E: Error + Send + Sync + 'static,

Create a new ProgramError from any error type.

pub fn msg(msg: impl Into<String>) -> Self

Create a ProgramError from a string message.

Trait Implementations

impl Debug for ProgramError

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

Formats the value using the given formatter.

impl Display for ProgramError

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

Formats the value using the given formatter.

impl Error for ProgramError

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

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

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

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<Box<dyn Error + Send + Sync>> for ProgramError

fn from(err: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<Error> for ProgramError

fn from(err: Error) -> Self

Converts to this type from the input type.