Struct SparkError 

pub struct SparkError {
    pub kind: SparkErrorKind,
    pub error_class: String,
    pub params: BTreeMap<String, String>,
    pub message: String,
    pub sql_state: Option<String>,
    pub contexts: Vec<QueryContext>,
    pub server_stacktrace: Option<String>,
    pub grpc_code: Option<i32>,
    pub grpc_details: Option<Vec<u8>>,
}

Re-exported so fallible APIs (e.g. the #[spark_wasm_udf]-generated UDF constructors) can name the client’s Result/error types. A structured error carrying a PySpark error class and its message parameters.

Fields

kind: SparkErrorKind

Which Python exception type to raise at the PyO3 boundary.

error_class: String

PySpark error class (e.g. “INVALID_CONNECT_URL”), or empty for plain messages.

params: BTreeMap<String, String>

Message parameters keyed by name, as in messageParameters.

message: String

A pre-rendered message, used when no error class applies.

sql_state: Option<String>

SQL state code, if known (from the error-conditions registry).

contexts: Vec<QueryContext>

Query contexts where the error occurred.

server_stacktrace: Option<String>

Server-side stack trace, if available.

grpc_code: Option<i32>

Raw gRPC status code, if this error originated from a gRPC Status.

grpc_details: Option<Vec<u8>>

Raw grpc-status-details-bin (a serialized google.rpc.Status), if present. Lets the PyO3 layer reconstruct the exact typed pyspark exception.

Implementations

impl SparkError

pub fn value(error_class: &str, params: &[(&str, &str)]) -> SparkError

Create a ValueError-kind error with an error class and parameters.

pub fn connect_msg(message: impl Into<String>) -> SparkError

Create a Connect-kind error with a plain message (no error class).

pub fn value_msg(message: impl Into<String>) -> SparkError

Create a ValueError-kind error with a plain message (no error class).

For invalid client-side configuration (e.g. a malformed connection string) that has no registered error class. Surfaces as PySparkValueError on the Python side, matching how the reference client reports connection-string problems, rather than the generic runtime kind.

pub fn classed( kind: SparkErrorKind, error_class: &str, params: &[(&str, &str)], ) -> SparkError

Create an error of a specific kind with an error class and parameters.

pub fn message(&self) -> String

Get the rendered message for this error, performing template substitution.

If an error_class is set, looks up the message template in error-conditions.json, substitutes <param_name> placeholders with values from params, and returns [ERROR_CLASS] rendered_message. Otherwise, returns the pre-set message.

Mirrors PySparkException.getMessage() from pyspark/errors/exceptions/base.py.

pub fn sql_state(&self) -> Option<String>

Get the SQL state code for this error, if known.

pub fn from_grpc_status(status: Status) -> SparkError

Convert a gRPC Status to a SparkError, extracting error class and parameters from metadata.

Mirrors convert_exception from pyspark.errors.exceptions.connect.

pub fn get_condition(&self) -> Option<String>

Get the error condition (error class).

Mirrors PySparkException.getCondition() from PySpark.

pub fn get_error_class(&self) -> Option<String>

Get the error class (deprecated, use get_condition instead).

Mirrors PySparkException.getErrorClass() from PySpark (deprecated).

pub fn get_message_parameters(&self) -> Option<BTreeMap<String, String>>

Get the message parameters.

Mirrors PySparkException.getMessageParameters() from PySpark.

pub fn get_sql_state(&self) -> Option<String>

Get the SQL state code, if known.

Mirrors PySparkException.getSqlState() from PySpark.

pub fn get_message(&self) -> String

Get the rendered error message.

Mirrors PySparkException.getMessage() from PySpark.

pub fn get_query_context(&self) -> Vec<QueryContext>

Get the query contexts where this error occurred.

Mirrors PySparkException.getQueryContext() from PySpark.

pub fn get_stacktrace(&self) -> Option<String>

Get the server-side stack trace, if available.

pub fn grpc_code(&self) -> Option<i32>

Raw gRPC status code, if this error came from a gRPC Status.

pub fn grpc_details(&self) -> Option<&[u8]>

Raw grpc-status-details-bin bytes (serialized google.rpc.Status), if present.

Trait Implementations

impl Clone for SparkError

fn clone(&self) -> SparkError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparkError

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

Formats the value using the given formatter.

impl Display for SparkError

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

Formats the value using the given formatter.

impl Error for SparkError

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.