grafbase-sdk 0.23.1

An SDK to implement extensions for the Grafbase Gateway
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

use crate::{types::Headers, wit};

/// Represents the parts of an HTTP request, including the URL, method, and headers.
#[non_exhaustive]
pub struct HttpRequestParts {
    /// The URL of the HTTP request.
    pub url: String,
    /// The HTTP method of the request, such as GET, POST, etc.
    pub method: http::Method,
    /// The headers of the HTTP request.
    pub headers: Headers,
}

impl From<wit::HttpRequestParts> for HttpRequestParts {
    fn from(parts: wit::HttpRequestParts) -> Self {
        Self {
            url: parts.url,
            method: parts.method.into(),
            headers: parts.headers.into(),
        }
    }
}

impl From<HttpRequestParts> for wit::HttpRequestParts {
    fn from(parts: HttpRequestParts) -> Self {
        Self {
            url: parts.url,
            method: parts.method.into(),
            headers: parts.headers.into(),
        }
    }
}

/// Output type for the [on_request()](crate::HooksExtension::on_request()) hook.
#[derive(Default)]
pub struct OnRequestOutput {
    pub(crate) context: Vec<u8>,
    pub(crate) contract_key: Option<String>,
}

impl OnRequestOutput {
    /// Creates a new [OnRequestOutput] instance with default values.
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the contract key for the request.
    pub fn contract_key(mut self, contract_key: impl Into<String>) -> Self {
        self.contract_key = Some(contract_key.into());
        self
    }

    /// Set the Hooks context for the request.
    /// Accessible by other extensions.
    pub fn context(mut self, context: impl Into<Vec<u8>>) -> Self {
        self.context = context.into();
        self
    }
}