galvyn-core 0.2.1

Core concepts for galvyn like trait definitions
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

use axum::http::Method;

use crate::schema_generator::SchemaGenerator;

/// Context used by [`RequestPart`], [`RequestBody`], [`ResponsePart`] and [`ResponseBody`].
///
/// Most noteworthy, it contains the [`SchemaGenerator`] implementors can use to generate json schemas.
///
/// It also wraps some additional context about the endpoint for which the schemas should be generated.
#[non_exhaustive]
pub struct EndpointContext<'ctx> {
    /// State for generating schemas from types implementing [`JsonSchema`]
    pub generator: &'ctx mut SchemaGenerator,

    /// HTTP method of the endpoint to generate schemas for
    pub method: &'ctx Method,

    /// Url path of the endpoint to generate schemas for
    pub path: &'ctx str,
}

impl<'ctx> EndpointContext<'ctx> {
    #[doc(hidden)]
    pub fn _new(
        generator: &'ctx mut SchemaGenerator,
        method: &'ctx Method,
        path: &'ctx str,
    ) -> Self {
        Self {
            generator,
            method,
            path,
        }
    }
}