confluent_kafka/common/errors/wakeup_error.rs
1// Copyright 2025 Confluent Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Translated from `org.apache.kafka.common.errors.WakeupException`.
16
17use crate::common::error::kafka_error_type;
18
19kafka_error_type! {
20 /// Error used to indicate preemption of a blocking operation by an external task. For example,
21 /// `KafkaConsumer::wakeup` can be used to break out of an active `KafkaConsumer::poll`, which
22 /// would return this error.
23 ///
24 /// # Translation notes
25 ///
26 /// No protocol code. Java `extends` chain: `WakeupException` -> `KafkaException`.
27 #[doc(alias = "org.apache.kafka.common.errors.WakeupException")]
28 WakeupError,
29 extends: [
30 is_kafka_error,
31 is_wakeup_error,
32 ],
33}