sark-core 0.22.0

Fiber-free request, route, dispatch, and lifecycle core for Sark
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

use std::fmt;

use crate::manifold::{client, stream};

/// Carrier failure class visible above a wire implementation.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Error {
    Blocked,
    Unavailable,
    Capacity,
    Protocol,
}

/// Classifies a carrier failure without consuming its exact cause.
pub trait Classify: fmt::Debug {
    fn kind(&self) -> Error;
}

/// Semantic reason for retiring one request stream.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Reset {
    Cancelled,
    Refused,
    Internal,
    Other,
    /// Carrier reports exhausted bandwidth.
    ResourceExhausted,
    /// Carrier reports insufficient protocol security.
    InadequateSecurity,
}

/// Peer connection shutdown classification.
#[derive(Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum Shutdown {
    Clean,
    Failed,
}

const _: () = assert!(core::mem::size_of::<Shutdown>() == core::mem::size_of::<bool>());
const _: () = assert!(core::mem::align_of::<Shutdown>() == core::mem::align_of::<bool>());

/// One response-side event produced by an HTTP client carrier.
pub enum Response<C: client::Connection + ?Sized> {
    Head {
        message: C::Message,
        fields: C::Fields,
        selection: C::Selection,
        section: stream::Section,
    },
    Data {
        message: C::Message,
        data: C::Data,
    },
    Reset {
        stream: C::Key,
        reason: Reset,
    },
    GoAway {
        boundary: C::GoAway,
        shutdown: Shutdown,
    },
}