breadx 0.2.2

Implementation of the X Window System Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

// MIT/Apache2 License

#[cfg(all(feature = "std", unix))]
use super::unix;
use crate::Fd;
use alloc::{boxed::Box, vec::Vec};
use core::{future::Future, pin::Pin};

#[cfg(all(feature = "std", unix))]
use async_net::unix::UnixStream;
#[cfg(feature = "std")]
use async_net::TcpStream;

#[cfg(not(unix))]
use super::standard_fd_warning;

#[cfg(all(not(unix), feature = "std"))]
use futures_lite::io::{AsyncReadExt, AsyncWriteExt};

/// Generic future for connections;
pub type GenericConnFuture<'future> = Pin<Box<dyn Future<Output = crate::Result> + Send + 'future>>;

/// Asynchronous breadx connection.
pub trait AsyncConnection {
    /// Send a packet across the connection in an async manner.
    fn send_packet<'future, 'a, 'b, 'c>(
        &'a mut self,
        bytes: &'b [u8],
        fds: &'c mut Vec<Fd>,
    ) -> GenericConnFuture<'future>
    where
        'a: 'future,
        'b: 'future,
        'c: 'future;

    /// Read a packet from the connection in an async manner.
    fn read_packet<'future, 'a, 'b, 'c>(
        &'a mut self,
        bytes: &'b mut [u8],
        fds: &'c mut Vec<Fd>,
    ) -> GenericConnFuture<'future>
    where
        'a: 'future,
        'b: 'future,
        'c: 'future;
}

macro_rules! unix_aware_async_connection_impl {
    ($name: ident) => {
        impl AsyncConnection for $name {
            #[inline]
            fn send_packet<'future, 'a, 'b, 'c>(
                &'a mut self,
                bytes: &'b [u8],
                fds: &'c mut Vec<Fd>,
            ) -> GenericConnFuture<'future>
            where
                'a: 'future,
                'b: 'future,
                'c: 'future,
            {
                cfg_if::cfg_if! {
                    if #[cfg(unix)] {
                        Box::pin(
                            unix::send_packet_unix_async(self.clone().into(), bytes, fds)
                        )
                    } else {
                        standard_fd_warning(fds);
                        Box::pin(async move {
                            self.write_all(bytes).await?;
                            Ok(())
                        })
                    }
                }
            }

            #[inline]
            fn read_packet<'future, 'a, 'b, 'c>(
                &'a mut self,
                bytes: &'b mut [u8],
                fds: &'c mut Vec<Fd>,
            ) -> GenericConnFuture<'future>
            where
                'a: 'future,
                'b: 'future,
                'c: 'future,
            {
                cfg_if::cfg_if! {
                    if #[cfg(unix)] {
                        Box::pin(
                           unix::read_packet_unix_async(self.clone().into(), bytes, fds)
                        )
                    } else {
                        let _ = fds;
                        Box::pin(async move {
                            self.read_exact(bytes).await?;
                            Ok(())
                        })
                    }
                }
            }
        }
    };
}

#[cfg(feature = "std")]
unix_aware_async_connection_impl! { TcpStream }

#[cfg(all(feature = "std", unix))]
unix_aware_async_connection_impl! { UnixStream }