Struct TransportRequest

Source

pub struct TransportRequest<'a> { /* private fields */ }

Expand description

Provider-neutral request passed to a blocking transport.

Implementations§

Source §

impl<'a> TransportRequest<'a>

Source

pub const fn new(method: Method, target: RequestTarget<'a>) -> Self

Creates a bodyless request.

Examples found in repository ?

examples/provider_neutral.rs (line 12)

6fn main() {
7    let provider = Provider::Hetzner;
8    let family = ApiFamily::Cloud;
9    let Ok(target) = RequestTarget::new("/servers?page=1") else {
10        return;
11    };
12    let request = TransportRequest::new(Method::Get, target);
13
14    assert_eq!(provider, Provider::Hetzner);
15    assert_eq!(family, ApiFamily::Cloud);
16    assert_eq!(request.method(), Method::Get);
17    assert_eq!(request.target().as_str(), "/servers?page=1");
18    assert!(request.body().is_empty());
19}

Source

pub const fn with_body(self, body: &'a [u8]) -> Self

Adds a borrowed request body.

Source

pub const fn with_content_type(self, content_type: ContentType<'a>) -> Self

Adds an explicit content type for the borrowed request body.

Source

pub const fn method(self) -> Method

Returns the HTTP method.

Examples found in repository ?

examples/provider_neutral.rs (line 16)

6fn main() {
7    let provider = Provider::Hetzner;
8    let family = ApiFamily::Cloud;
9    let Ok(target) = RequestTarget::new("/servers?page=1") else {
10        return;
11    };
12    let request = TransportRequest::new(Method::Get, target);
13
14    assert_eq!(provider, Provider::Hetzner);
15    assert_eq!(family, ApiFamily::Cloud);
16    assert_eq!(request.method(), Method::Get);
17    assert_eq!(request.target().as_str(), "/servers?page=1");
18    assert!(request.body().is_empty());
19}

Source

pub const fn target(self) -> RequestTarget<'a>

Returns the validated origin-form target.

Examples found in repository ?

examples/provider_neutral.rs (line 17)

6fn main() {
7    let provider = Provider::Hetzner;
8    let family = ApiFamily::Cloud;
9    let Ok(target) = RequestTarget::new("/servers?page=1") else {
10        return;
11    };
12    let request = TransportRequest::new(Method::Get, target);
13
14    assert_eq!(provider, Provider::Hetzner);
15    assert_eq!(family, ApiFamily::Cloud);
16    assert_eq!(request.method(), Method::Get);
17    assert_eq!(request.target().as_str(), "/servers?page=1");
18    assert!(request.body().is_empty());
19}

Source

pub const fn body(self) -> &'a [u8] ⓘ

Returns the borrowed body bytes.

Examples found in repository ?

examples/provider_neutral.rs (line 18)

6fn main() {
7    let provider = Provider::Hetzner;
8    let family = ApiFamily::Cloud;
9    let Ok(target) = RequestTarget::new("/servers?page=1") else {
10        return;
11    };
12    let request = TransportRequest::new(Method::Get, target);
13
14    assert_eq!(provider, Provider::Hetzner);
15    assert_eq!(family, ApiFamily::Cloud);
16    assert_eq!(request.method(), Method::Get);
17    assert_eq!(request.target().as_str(), "/servers?page=1");
18    assert!(request.body().is_empty());
19}