tokio_quiche/
result.rs

1// Copyright (C) 2025, Cloudflare, Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//
11//     * Redistributions in binary form must reproduce the above copyright
12//       notice, this list of conditions and the following disclaimer in the
13//       documentation and/or other materials provided with the distribution.
14//
15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
16// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
17// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
19// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27use std::error::Error;
28use std::io;
29
30/// Generic thread-safe boxed error.
31///
32/// From all our prior experience we've learned that there is very little
33/// practical use in concrete error types. On the surface it seems appealing to
34/// use such errors, because they have, ahem, concrete type. But the flip side
35/// is that code in big projects quickly ends up being polluted with endless
36/// adapter error types to combine different APIs together, or, even worse, an
37/// Error god-object gets introduced to accommodate all possible error types.
38///
39/// On rare occasions concrete error types can be used, where handling of the
40/// error depends on the error kind. But, in practice, such cases are quite
41/// rare.
42pub type BoxError = Box<dyn Error + Send + Sync + 'static>;
43/// [Result] alias based on [`BoxError`] for this crate.
44pub type QuicResult<T> = Result<T, BoxError>;
45
46/// Extension trait to add methods to [Result].
47pub trait QuicResultExt<T, E> {
48    /// Turns the [Result] into an [`io::Result`] with
49    /// [`ErrorKind::Other`](io::ErrorKind::Other).
50    fn into_io(self) -> io::Result<T>
51    where
52        E: Into<BoxError>;
53}
54
55impl<T, E> QuicResultExt<T, E> for Result<T, E> {
56    #[inline]
57    fn into_io(self) -> io::Result<T>
58    where
59        E: Into<BoxError>,
60    {
61        self.map_err(io::Error::other)
62    }
63}
tokio_quiche/result.rs

tokio_quiche/
result.rs
