tokio_quiche/quic/connection/
error.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 crate::result::QuicResult;
28use std::io;
29
30/// Additional error types that can occur during a QUIC handshake.
31///
32/// Protocol errors are returned directly as [`quiche::Error`] values.
33#[non_exhaustive]
34#[derive(Debug, Clone, thiserror::Error)]
35pub enum HandshakeError {
36    /// The configured handshake timeout has expired.
37    #[error("handshake timeout expired")]
38    Timeout,
39    /// The connection was closed while handshaking, for example by the peer.
40    #[error("connection closed during Handshake stage")]
41    ConnectionClosed,
42}
43
44// We use io::Result for `IQC::handshake` to provide a uniform interface with
45// handshakes of other connection types, for example TLS. This is a best-effort
46// mapping to match the existing io::ErrorKind values.
47impl From<HandshakeError> for io::Error {
48    fn from(err: HandshakeError) -> Self {
49        match err {
50            HandshakeError::Timeout => Self::new(io::ErrorKind::TimedOut, err),
51            HandshakeError::ConnectionClosed =>
52                Self::new(io::ErrorKind::NotConnected, err),
53        }
54    }
55}
56
57/// Derives a [`std::io::Result`] from `IoWorker::handshake`'s result without
58/// taking ownership of the original [`Result`].
59pub(crate) fn make_handshake_result<T>(res: &QuicResult<()>) -> io::Result<T> {
60    let Err(err) = res else {
61        return Err(io::Error::other(
62            "Handshake transitioned to Closing without error",
63        ));
64    };
65
66    // BoxError does not force its content to be Clone, so we need to check for
67    // the types we expect manually & clone/copy them.
68    if let Some(hs_err) = err.downcast_ref::<HandshakeError>() {
69        Err(hs_err.clone().into())
70    } else if let Some(quiche_err) = err.downcast_ref::<quiche::Error>() {
71        Err(io::Error::other(*quiche_err))
72    } else {
73        let data_fmt = format!("unexpected handshake error: {err}");
74        Err(io::Error::other(data_fmt))
75    }
76}
tokio_quiche/quic/connection/error.rs

tokio_quiche/quic/connection/
error.rs
