Module err

Error handling logic for our ffi code.

Structs

FfiError

An error as returned by the Arti FFI code.

Constants

ARTI_RPC_STATUS_ALL_CONNECT_ATTEMPTS_FAILED

All of our attempts to connect to Arti failed, or we reached an explicit instruction to “abort” our connection attempts.

ARTI_RPC_STATUS_BAD_AUTH

We tried to authenticate with Arti, but it rejected our attempt.

ARTI_RPC_STATUS_BAD_CONNECT_POINT_PATH

We were unable to parse or resolve an entry in our connect point search path.

ARTI_RPC_STATUS_CONNECT_IO

Tried to connect to Arti, but an IO error occurred.

ARTI_RPC_STATUS_CONNECT_POINT_NOT_USABLE

We tried to connect to Arti at a given connect point, but it could not be used: either because we don’t know how, or because we were not able to access some necessary file or directory.

ARTI_RPC_STATUS_INTERNAL

An internal error occurred in the arti rpc client.

ARTI_RPC_STATUS_INVALID_INPUT

One or more of the inputs to a library function was invalid.

ARTI_RPC_STATUS_NOT_AUTHENTICATED

Some operation failed because it was attempted on an unauthenticated channel.

ARTI_RPC_STATUS_NOT_SUPPORTED

Tried to use some functionality (for example, an authentication method or connection scheme) that wasn’t available on this platform or build.

ARTI_RPC_STATUS_PEER_PROTOCOL_VIOLATION

Our peer has, in some way, violated the Arti-RPC protocol.

ARTI_RPC_STATUS_PROXY_IO

An IO error occurred while trying to negotiate a data stream using Arti as a proxy.

ARTI_RPC_STATUS_PROXY_STREAM_FAILED

An attempt to negotiate a data stream through Arti failed, with an error from the proxy protocol.

ARTI_RPC_STATUS_REQUEST_COMPLETED

Tried to check the status of a request and found that it was no longer running.

ARTI_RPC_STATUS_REQUEST_FAILED

The peer reports that one of our requests has failed.

ARTI_RPC_STATUS_SHUTDOWN

The peer has closed our connection; possibly because it is shutting down.

ARTI_RPC_STATUS_SUCCESS

The function has returned successfully.

Functions

arti_rpc_err_clone^⚠

Make and return copy of a provided error.

arti_rpc_err_free^⚠

Release storage held by a provided error.

arti_rpc_err_message^⚠

Return a human-readable error message associated with a given error.

arti_rpc_err_os_error_code^⚠

Return the OS error code underlying err, if any.

arti_rpc_err_response^⚠

Return a Json-formatted error response associated with a given error.

arti_rpc_err_status^⚠

Return the status code associated with a given error.

arti_rpc_status_to_str

Return a string representing the meaning of a given ArtiRpcStatus.

Type Aliases

ArtiRpcError

An error returned by the Arti RPC code, exposed as an object.