zrx_executor/executor/
error.rs

1// Copyright (c) Zensical LLC <https://zensical.org>
2
3// SPDX-License-Identifier: MIT
4// Third-party contributions licensed under CLA
5
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to
8// deal in the Software without restriction, including without limitation the
9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23
24// ----------------------------------------------------------------------------
25
26//! Executor error.
27
28use crossbeam::channel::TrySendError;
29use std::result;
30use thiserror::Error;
31
32use super::task::Task;
33
34// ----------------------------------------------------------------------------
35// Enums
36// ----------------------------------------------------------------------------
37
38/// Executor error.
39#[derive(Debug, Error)]
40pub enum Error {
41    /// Task submission failed.
42    #[error("task submission failed")]
43    Submit(Box<dyn Task>),
44
45    /// Signal poisoned.
46    #[error("signal poisoned")]
47    Signal,
48}
49
50// ----------------------------------------------------------------------------
51// Trait implementations
52// ----------------------------------------------------------------------------
53
54impl From<TrySendError<Box<dyn Task>>> for Error {
55    /// Creates an error from a crossbeam channel error.
56    ///
57    /// This implementation extracts the [`Task`] that could not be submitted,
58    /// and wraps it in an [`Error::Submit`] variant for a later retry. To our
59    /// current knowledge, it can't possibly happen that the channel becomes
60    /// disconnected without explicitly terminating the executor.
61    #[inline]
62    fn from(err: TrySendError<Box<dyn Task>>) -> Self {
63        Error::Submit(err.into_inner())
64    }
65}
66
67// ----------------------------------------------------------------------------
68// Type aliases
69// ----------------------------------------------------------------------------
70
71/// Executor result.
72pub type Result<T = ()> = result::Result<T, Error>;
zrx_executor/executor/error.rs

zrx_executor/executor/
error.rs
