Skip to main content

karyon_net/
lib.rs

1#![doc = include_str!("../README.md")]
2
3#[cfg(all(feature = "quic", not(any(feature = "aws-lc-rs", feature = "ring"))))]
4compile_error!("The `quic` feature needs a rustls crypto provider: enable `aws-lc-rs` or `ring`.");
5
6#[cfg(any(feature = "tls", feature = "quic"))]
7use std::time::Duration;
8
9mod transports;
10
11mod error;
12
13mod endpoint;
14
15mod buffer;
16
17pub mod codec;
18
19mod layer;
20pub mod layers;
21
22mod message;
23mod stream;
24mod stream_mux;
25
26// Framing
27#[cfg(feature = "framing")]
28mod framed;
29
30#[cfg(feature = "framing")]
31pub use framed::{FramedConn, FramedReader, FramedWriter, framed};
32
33// Byte containers
34pub use buffer::{Buffer, ByteBuffer, Bytes};
35
36// Stream types
37pub use stream::ByteStream;
38
39// Message read/write traits implemented by FramedReader/FramedWriter and WsReader/WsWriter.
40pub use message::{MessageRx, MessageTx};
41
42#[cfg(feature = "ws")]
43pub use layers::ws::{WsConn, WsLayer, WsReader, WsWriter};
44
45// Layer traits
46pub use layer::{ClientLayer, ServerLayer};
47
48// Stream mux
49pub use stream_mux::StreamMux;
50
51// Endpoint types
52pub use endpoint::{Addr, Endpoint, Port, ToEndpoint};
53
54// Error types
55pub use error::{Error, Result};
56
57/// Max time the `accept` helpers of TLS and QUIC wait for a handshake.
58#[cfg(any(feature = "tls", feature = "quic"))]
59const ACCEPT_HANDSHAKE_TIMEOUT: Duration = Duration::from_secs(10);
60
61// Base transports
62#[cfg(feature = "tcp")]
63pub use transports::tcp;
64
65#[cfg(feature = "udp")]
66pub use transports::udp;
67
68#[cfg(all(feature = "unix", target_family = "unix"))]
69pub use transports::unix;
70
71#[cfg(feature = "quic")]
72pub use transports::quic;
73
74// Layers
75#[cfg(feature = "proxy")]
76pub use layers::proxy;
77
78#[cfg(feature = "tls")]
79pub use layers::tls;
80
81// Re-exports
82#[cfg(any(feature = "tls", feature = "quic"))]
83pub use karyon_async_rustls as async_rustls;