Struct LocalTimeoutError 

pub struct LocalTimeoutError { /* private fields */ }

A wait on a future timed out.

Corresponds to Java’s java.util.concurrent.TimeoutException, thrown by Future.get(timeout, unit) — not to org.apache.kafka.common.errors.TimeoutException, which is a RetriableException under KafkaException and is spelled Error::timeout. The two are unrelated classes that share a simple name; conflating them makes a local await timeout answer true to is_retriable_error() / is_api_error() / is_kafka_error() and report a wire code, none of which Java does. A plain checked java.util class outside the Kafka hierarchy, so no predicate holds.

The Local prefix marks this as a JDK class rather than a Kafka one, per CLAUDE.md §2 — every java.* error carries it, independently of the subpackage. That is what separates this from Error::Timeout: Java tells the two TimeoutExceptions apart by package, and a flat enum cannot, so the prefix carries what the package used to. It also says something the package name would not: these errors are raised here, never reported by a broker, which is why none of them has a wire code.

Implementations

impl LocalTimeoutError

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

Create the error with the given message and no cause, mirroring the (String message) constructor.

Keeps the plain name under CLAUDE.md §2, for consistency with kafka_error_type! — see the note on this macro about the constructors these classes deliberately do not model. (Deliberately not an intra-doc link: this doc comment expands into each declaring module, where that macro is not in scope.)

pub fn with_source(message: impl Into<String>, source: Error) -> Self

Create the error with the given message and an underlying cause, mirroring the (String message, Throwable cause) constructor.

Suffixed with the one parameter beyond the {message} intersection (CLAUDE.md §2) — see new.

pub fn message(&self) -> &str

The error message.

pub fn source(&self) -> Option<&Error>

The underlying cause, if any. Mirrors Java’s getCause().

Trait Implementations

impl Clone for LocalTimeoutError

fn clone(&self) -> LocalTimeoutError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalTimeoutError

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

Formats the value using the given formatter.

impl Display for LocalTimeoutError

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

Formats the value using the given formatter.

impl Error for LocalTimeoutError

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.