sova-core 0.1.7

Core HTTP primitives for Sova (App, Router, Request, Response)
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
111
112
113
114
115
116
117
118

//! Sova core — App, Router, Request, Response, middleware, server.
//!
//! # Request path
//!
//! `accept` → `server/conn` → `to_sova_request` → `CompiledRouter::dispatch`
//! → root middleware → matchit → route middleware → handler → [`IntoResponse`]
//! → hyper response.
//!
//! # Public surface
//!
//! This crate root exports names used by applications. Plugin authors and
//! advanced integrations use [`extend`].
//!
//! Product docs: <https://s00d.github.io/sova/> (VitePress guide `/guide/concepts`).

mod request_id;
mod app;
mod config;
mod error;
mod handler;
pub mod html;
mod human;
mod limits;
mod middleware;
mod plugin;
mod raw;
mod request;
mod response;
mod route_value;
mod router;
mod server;
mod service;
mod share;
mod state;
mod tracing_init;
mod upgrade;
#[cfg(any(test, feature = "testing"))]
mod test_client;
#[cfg(feature = "tls")]
mod tls;

// Application-facing API (~16–18 names).
pub use app::{App, BoundApp, CheckKind, CheckResult, Http, Server};
pub use config::ConfigDoc;
pub use error::{Error, IntoResponse, Result};
pub use middleware::{
    after, around, before, logger, logger_skip_path, logger_skip_paths, map_html, with_state, Next,
};
pub use plugin::{
    check_plugin_sdk, InstalledPlugin, Plugin, PluginMeta, PluginSdkVersion, SdkCompat,
    PLUGIN_SDK_VERSION,
};
pub use request::{FormData, Request, Upload, UploadRules};
pub use request_id::{ensure_request_id, request_id, RequestId};
pub use response::{referer_or, Html, Json, NoContent, Redirect, Response, Text};
pub use router::Router;
pub use server::{ClientAddr, RateLimitIdentity};
pub use service::{BackgroundService, Shutdown};
pub use share::{Cell, Slot};
pub use state::{MatchedRoute, MatchedRouteCapture};
pub use tracing_init::{
    parse_log_rotate, set_log_event_hook, add_log_event_hook, LogConfig, LogEventHook, LogRecord, LogRotate,
};
#[cfg(any(test, feature = "testing"))]
pub use service::{shutdown_channel, ShutdownSender};
#[cfg(any(test, feature = "testing"))]
pub use middleware::logger_clear_skip_paths;
#[cfg(any(test, feature = "testing"))]
pub use test_client::{ClientRequest, RequestHook, ResponseAssert, TestClient};
pub use upgrade::{OnUpgrade, UpgradePermit};

#[cfg(feature = "tls")]
pub use tls::Tls;

/// Extension / plugin-author API (handlers, bodies, route introspection, …).
///
/// Prefer this module when writing plugins: middleware helpers (`with_leaked`,
/// `named`), [`PluginMeta`](crate::PluginMeta) / [`PLUGIN_SDK_VERSION`](crate::PLUGIN_SDK_VERSION),
/// and route introspection types. Application `main` usually imports from the crate root
/// (or the `sova` facade) instead.
pub mod extend {
    pub use crate::app::Bind;
    pub use crate::plugin::{
        check_plugin_sdk, InstalledPlugin, PluginMeta, PluginSdkVersion, SdkCompat,
        PLUGIN_SDK_VERSION,
    };
    pub use crate::handler::{
        BoxFuture, ErrorResponse, FallibleHandler, Handler, IntoHandler,
    };
    pub use crate::html::{
        find_ci, inject, inject_after_open_tag, inject_before, inject_body_end, inject_head,
        replace_between, replace_once, HtmlAnchor, HtmlInject,
    };
    pub use crate::middleware::{
        after, around, before, logger_skip_path, logger_skip_paths, map_html, named, with_leaked,
        IntoMiddleware, IntoMwEntry, Middleware, MwEntry,
    };
    pub use crate::raw::{IntoRawHandler, RawHandler};
    pub use crate::request::{FormData, RequestBuilder, Upload, UploadRules};
    pub use crate::request_id::{ensure_request_id, request_id, RequestId};
    pub use crate::response::{Body, BoxError, HttpBody, ResponseBody};
    pub use crate::human::{parse_bytes, parse_duration};
    pub use crate::limits::{tighten_deadline, Deadline, MaxBody, RequestTimeout};
    pub use crate::route_value::{BuildCtx, MetaMap, Needs, RouteValue};
    pub use crate::router::{
        join_paths, normalize_path, to_brace_path, RouteEntry, RouteTable,
    };
    pub use crate::service::wait_shutdown;
    pub use crate::share::{Cell, Slot};
    pub use crate::state::{
        Extensions, MatchedMeta, MatchedMetaCapture, MatchedRoute, MatchedRouteCapture, StateMap,
        TypeMap,
    };
    pub use crate::tracing_init::{
        add_log_event_hook, ensure_tracing, parse_log_rotate, set_log_event_hook, LogConfig,
        LogEventHook, LogRecord, LogRotate,
    };
}