hotaru 0.8.3

Small, sweet, easy framework with a protocol-neutral, no_std-ready core
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

//! Hotaru — the umbrella crate. Re-exports the public surface of
//! `hotaru_core`, `hotaru_http`, `hotaru_trans` and friends behind a
//! single import root. Most users want [`prelude`]; HTTP users also
//! want [`http`].

/// HTTP-specific re-exports — request/response types, the `HTTP`
/// protocol alias, and (with the `https` feature) the TLS variants.
#[cfg(feature = "http")]
pub mod http;

/// Curated re-exports for typical user code: `Server`, `Client`,
/// `endpoint!` / `outpoint!` macros, the `Lazy`-wrapped `S*` aliases,
/// and the core protocol traits.
pub mod prelude;

#[cfg(feature = "tokio")]
pub use hotaru_rt_tokio::TokioRuntime;

/// Tokio-backed server alias used by the umbrella crate.
#[cfg(feature = "tokio")]
pub type Server<TS = hotaru_io_tokio::TcpTransport, Rt = hotaru_rt_tokio::TokioRuntime> =
    hotaru_core::app::server::Server<TS, Rt>;
#[cfg(not(feature = "tokio"))]
pub type Server<TS, Rt> = hotaru_core::app::server::Server<TS, Rt>;

/// Tokio-backed client alias used by the umbrella crate.
#[cfg(feature = "tokio")]
pub type Client<TS = hotaru_io_tokio::TcpTransport, Rt = hotaru_rt_tokio::TokioRuntime> =
    hotaru_core::app::client::Client<TS, Rt>;
#[cfg(not(feature = "tokio"))]
pub type Client<TS, Rt> = hotaru_core::app::client::Client<TS, Rt>;
pub use hotaru_core::app::common::{RunMode, TimeoutSetting};
pub use hotaru_core::url::PathPattern;
/// Umbrella alias for Hotaru's URL routing tree.
#[cfg(feature = "io_tokio")]
pub type Url<C, TS = hotaru_io_tokio::TcpTransport> = hotaru_core::url::UrlRoot<C, TS>;
/// Umbrella alias for Hotaru's URL routing tree.
#[cfg(not(feature = "io_tokio"))]
pub type Url<C, TS> = hotaru_core::url::UrlRoot<C, TS>;
pub use hotaru_core::url::pattern::path_pattern_creator::{
    any as AnyUrl, any_path as AnyPath, literal_path as LitUrl, regex_path as RegUrl,
    trailing_slash as TrailingSlash,
};
pub use hotaru_core::url::{FrameNode, WalkCursor, WalkFrame};

/// Umbrella alias for building protocol handler registries.
#[cfg(feature = "io_tokio")]
pub type ProtocolHandlerBuilder<P, TS = hotaru_io_tokio::TcpTransport> =
    hotaru_core::executable::ProtocolEntryBuilder<P, TS>;
/// Umbrella alias for building protocol handler registries.
#[cfg(not(feature = "io_tokio"))]
pub type ProtocolHandlerBuilder<P, TS> = hotaru_core::executable::ProtocolEntryBuilder<P, TS>;
pub use hotaru_core::app::server::ProtocolRegistryKind;
pub use hotaru_core::executable::ProtocolRegistryBuilder;
pub use hotaru_core::executable::middleware::AsyncMiddleware;

#[cfg(feature = "full")]
pub use hotaru_core::TemplateManager;
pub use hotaru_core::Value;
pub use hotaru_core::object;

pub use hotaru_core::connection::ConnStream;
pub use hotaru_core::connection::error::{ConnectionError, Result};
pub use hotaru_core::connection::{Inbound, Outbound};
pub use hotaru_core::protocol::{
    BoxProtocolError, DefaultProtocolError, EmptyError, EndpointOutcome, Message, Protocol,
    ProtocolError, ProtocolRole, RequestContext, Stream,
};
// `hotaru_io_embedded` is not surfaced through the umbrella in 0.8.x (`hotaru`
// is std-only — see Cargo.toml). For no_std, use `hotaru_core` +
// `hotaru_io_embedded` directly.
// #[cfg(feature = "io_embedded")]
// pub use hotaru_io_embedded::{EmbeddedBackend, EmbeddedIo};
#[cfg(feature = "io_futures")]
pub use hotaru_io_futures::{FuturesBackend, FuturesIo};
#[cfg(feature = "io_tokio")]
pub use hotaru_io_tokio::{
    TcpAccepter, TcpConnector, TcpConnectorAddr, TcpInbound, TcpMeta, TcpOutbound, TcpStream,
    TcpTransport, TokioBackend, TokioIo,
};

pub use hotaru_core::extensions::*;

pub use akari;
pub use hotaru_core;
#[cfg(feature = "http")]
pub use hotaru_http;

pub use hotaru_trans as hrt;
pub use hrt::call;
pub use hrt::endpoint;
pub use hrt::middleware;
pub use hrt::outpoint;
pub use hrt::run;
pub use hrt::{run_server, run_server_no_block, run_server_no_block_until, run_server_until};
pub use hrt::{LClient, LPattern, LServer, LUrl};

#[cfg(not(feature = "external-ctor"))]
pub use hrt::ctor as hrt_ctor;

#[cfg(feature = "http")]
pub use ahttpm;

#[cfg(feature = "lib")]
pub use hotaru_lib;