Skip to main content

Crate hotaru

Crate hotaru 

Source

Re-exports§

pub use akari;
pub use hotaru_core;
pub use hotaru_http;
pub use hotaru_trans as hrt;
pub use ahttpm;
pub use hotaru_lib;

Modules§

http
HTTP-specific re-exports for standard Hotaru HTTP implementation
prelude

Macros§

LClient
LClient! - Creates a lazy static Client instance.
LPattern
LPattern! - Creates a lazy static PathPattern instance
LServer
LServer! - Creates a lazy static Server instance.
LUrl
LUrl! - Creates a lazy static Url instance
call
Spawn a persistent outpoint call. Two forms:
endpoint
middleware
object
A macro to create an Value from a literal or expression. It can handle dictionaries, lists, booleans, strings, and numeric values.
outpoint
run
One-shot outpoint request:

Structs§

Client
Outbound runtime for protocol-routed requests.
EmptyError
Template error type for RequestContext::Error.
Locals
String-based extension storage, typically used by application code Multiple values of the same type can be stored with different keys
LocalsClone
String-based extension storage, typically used by application code.
Params
Type-based extension storage, typically used by middleware Each type can have exactly one value
ParamsClone
Type-based extension storage, typically used by middleware.
ProtocolHandlerBuilder
Neutral builder for one protocol entry shared by server and client runtimes.
ProtocolRegistryBuilder
Builder for protocol registries assembled from neutral protocol entries.
Server
Server runtime for inbound protocol traffic.
TcpAccepter
Plain TCP accepter that returns the accepted stream unchanged.
TcpConnector
Plain TCP outbound connector.
TcpConnectorAddr
TCP connector that accepts a resolved socket address.
TcpInbound
Bound plain TCP inbound runtime.
TcpMeta
Connection metadata for plain TCP.
TcpOutbound
TCP outbound runtime using normal TcpStream::connect.
TcpTransport
Plain TCP transport.
TemplateManager
Manages template loading, caching, and rendering
Url
Root wrapper for a URL tree.
WalkCursor
Unstable Version: 0.8.1
WalkFrame
Unstable Version: 0.8.1

Enums§

ConnectionError
FrameNode
Unstable Version: 0.8.1
PathPattern
ProtocolRegistryKind
Optimization for single-protocol apps, which are common in practice.
ProtocolRole
Role of the protocol handler - server or client.
RunMode
Run mode for framework runtimes.
TimeoutSetting
Controls how long a timeout is, or whether it is active at all.
Value

Traits§

AsyncMiddleware
ConnStream
Stream abstraction for protocol-specific transports.
DefaultProtocolError
Marker so the blanket impl above does not conflict with hand-written impls that want custom can_continue behaviour. Implement this on types that should get the default can_continue() = false.
Inbound
Bound inbound runtime that accepts final wire streams.
Message
Protocol-defined message format.
Outbound
Outbound runtime that opens final wire streams.
ParamValue
Object-safe supertrait for stored values.
Protocol
User-defined protocol handler.
ProtocolError
Protocol-defined error. Each protocol owns its own concrete error type.
RequestContext
Context that flows through request handlers.
Stream
Protocol-defined stream abstraction.

Functions§

AnyPath
Creates a any path pattern. This is useful for matching any path. This is faster then regex when any path should be passed into the same endpoint
AnyUrl
Creates a any pattern. You may use this to match any string. This is faster then regex when any string should be passed into the same endpoint
LitUrl
Creates a literal path pattern. This is a wrapper around the literal_path function. This is useful for creating path patterns that are not regex.
RegUrl
Creates a regex path pattern. This is a wrapper around the regex_path function. This is useful for creating path patterns that are regex.
TrailingSlash
combine_hashmap
Helper function to merge two HashMap<K, V> without overwriting existing entries in a.

Type Aliases§

BoxProtocolError
Result

Attribute Macros§

hrt_ctor
Our own constructor attribute - works like #[ctor::ctor] but built-in Generates platform-specific linker sections for automatic initialization