sark 0.8.0

Simple Asynchronous Rust webKit - Server
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use std::ops::Range;

use super::PathProbe;
use super::request_impl::RouteRequestImpl;
use crate::{Request, request};

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct PathCapture {
    pub start: usize,
    pub end: usize,
}

impl PathCapture {
    pub const fn new(start: usize, end: usize) -> Self {
        Self { start, end }
    }

    pub const fn as_range(self) -> Range<usize> {
        self.start..self.end
    }
}

pub trait RouteParams: Sized {
    type Raw: Default;
    type Captures;

    fn from_raw(req: &Request, raw: Self::Raw) -> Option<Self>;

    fn from_captures<P: PathProbe>(path: &P, captures: Self::Captures) -> Option<Self>;
}

pub struct NoParams;

impl RouteParams for NoParams {
    type Raw = Self;
    type Captures = ();

    fn from_raw(_req: &Request, _raw: Self::Raw) -> Option<Self> {
        Some(Self)
    }

    fn from_captures<P: PathProbe>(_path: &P, _captures: Self::Captures) -> Option<Self> {
        Some(Self)
    }
}

pub trait RouteParamsRef<'req>: RouteParams {
    fn from_raw_ref(req: &request::Ref<'req, ()>, raw: <Self as RouteParams>::Raw) -> Option<Self>;
}

impl<'req> RouteParamsRef<'req> for NoParams {
    fn from_raw_ref(_req: &request::Ref<'req, ()>, _raw: Self::Raw) -> Option<Self> {
        Some(Self)
    }
}

impl Default for NoParams {
    fn default() -> Self {
        Self
    }
}

pub trait HeaderParams: Sized {}

#[derive(Default)]
pub struct NoHeaders;

impl HeaderParams for NoHeaders {}

pub struct EmptyParamsInner<'req> {
    #[doc(hidden)]
    pub __sark_m: core::marker::PhantomData<&'req ()>,
}

#[derive(Default)]
pub struct EmptyParamsRaw;

impl RouteParams for EmptyParamsRaw {
    type Raw = Self;
    type Captures = ();

    fn from_raw(_req: &crate::Request, raw: Self::Raw) -> Option<Self> {
        Some(raw)
    }

    fn from_captures<P: PathProbe>(_path: &P, _captures: Self::Captures) -> Option<Self> {
        Some(Self)
    }
}

impl<'req> RouteParams for EmptyParamsInner<'req> {
    type Raw = EmptyParamsRaw;
    type Captures = ();

    fn from_raw(_req: &crate::Request, _raw: Self::Raw) -> Option<Self> {
        Some(Self {
            __sark_m: core::marker::PhantomData,
        })
    }

    fn from_captures<P: PathProbe>(_path: &P, _captures: Self::Captures) -> Option<Self> {
        Some(Self {
            __sark_m: core::marker::PhantomData,
        })
    }
}

impl<'req> RouteParamsRef<'req> for EmptyParamsInner<'req> {
    fn from_raw_ref(_req: &request::Ref<'req, ()>, _raw: Self::Raw) -> Option<Self> {
        Some(Self {
            __sark_m: core::marker::PhantomData,
        })
    }
}

pub trait RouteSpec {
    type Request: RouteRequestImpl<
            HeaderSlot = Self::HeaderSlot,
            RawHeaders = Self::RawHeaders,
            RawParams = Self::RawParams,
        > + for<'req> RouteRequestImpl<
            ParamsInner<'req> = Self::Params<'req>,
            HeadersInner<'req> = Self::Headers<'req>,
        >;

    type Params<'req>: RouteParams + RouteParamsRef<'req>;
    type RawParams: Default;
    type Headers<'req>: HeaderParams;
    type RawHeaders: Default;
    type HeaderSlot: Copy;
    type Response<'req>: sark_core::http::Shape<'req>;
    type ParsedBody<'req>;

    type Captures;

    const STATIC_RESPONSE: bool = false;
    const RESPONSE_BODY_KIND: sark_core::http::body_kind::ResponseKind =
        sark_core::http::body_kind::ResponseKind::Inline;
    const REQUEST_BODY_KIND: sark_core::http::body_kind::RequestKind =
        sark_core::http::body_kind::RequestKind::Inline;
    const STREAMING_BODY: bool = matches!(
        Self::REQUEST_BODY_KIND,
        sark_core::http::body_kind::RequestKind::Stream,
    );
    const MAX_BODY: usize = 1024 * 1024;

    /// Emit the `Date` response header. `#[skip(date)]` sets this `false` for a
    /// route, trimming the header from its (static) responses.
    const EMIT_DATE: bool = true;
    /// Emit the `Server` response header. `#[skip(server)]` sets this `false`.
    const EMIT_SERVER: bool = true;

    fn parse_body<'req>(raw: &'req [u8]) -> sark_core::error::Result<Self::ParsedBody<'req>>;

    fn from_captures<P: PathProbe>(path: &P, captures: Self::Captures) -> Option<Self::RawParams>;
}