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 10)

6fn main() {
7    let Ok(target) = RequestTarget::new("/resources?page=1") else {
8        return;
9    };
10    let request = TransportRequest::new(Method::Get, target);
11
12    assert_eq!(request.method(), Method::Get);
13    assert_eq!(request.target().as_str(), "/resources?page=1");
14    assert!(request.body().is_empty());
15}

More examples

Hide additional examples

examples/prepared_request.rs (line 57)

46    fn prepare<'storage>(
47        &self,
48        storage: PreparationStorage<'storage>,
49    ) -> Result<PreparedRequest<'storage>, Self::Error> {
50        let (target_storage, _body_storage) = storage.into_parts();
51        let target = target_storage
52            .get_mut(..17)
53            .ok_or(PrepareError::TargetBuffer)?;
54        target.copy_from_slice(b"/resources?page=1");
55        let target = core::str::from_utf8(target).map_err(|_| PrepareError::InvalidTarget)?;
56        let target = RequestTarget::new(target).map_err(|_| PrepareError::InvalidTarget)?;
57        let request = TransportRequest::new(Method::Get, target);
58        let metadata = OperationMetadata::new(
59            OperationImpact::ReadOnly,
60            RequestSemantics::Safe,
61            RetryEligibility::ExplicitPolicy,
62            CostIntent::NoKnownCost,
63            RequestIdPolicy::Protected,
64        )
65        .map_err(|_| PrepareError::InvalidMetadata)?;
66        let response_policy = ResponsePolicy::new(
67            &OK_STATUS,
68            ContentTypePolicy::Required(&JSON_MEDIA),
69            ResponseBodyPolicy::Required,
70            65_536,
71        )
72        .map_err(|_| PrepareError::InvalidResponsePolicy)?;
73        let endpoint =
74            EndpointIdentity::new(EndpointScheme::Https, "api.example.invalid", 443, "/v1")
75                .map_err(|_| PrepareError::InvalidEndpoint)?;
76        Ok(PreparedRequest::new(
77            request,
78            ProviderService::from_marker::<ComputeService>(EndpointPolicy::fixed(endpoint)),
79            metadata,
80            response_policy,
81        ))
82    }

Source

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

Adds a borrowed request body.

Source

pub const fn with_headers(self, headers: RequestHeaders<'a>) -> Self

Adds a complete validated request-header block.

Source

pub const fn method(self) -> Method

Returns the HTTP method.

Examples found in repository ?

examples/provider_neutral.rs (line 12)

6fn main() {
7    let Ok(target) = RequestTarget::new("/resources?page=1") else {
8        return;
9    };
10    let request = TransportRequest::new(Method::Get, target);
11
12    assert_eq!(request.method(), Method::Get);
13    assert_eq!(request.target().as_str(), "/resources?page=1");
14    assert!(request.body().is_empty());
15}

More examples

Hide additional examples

examples/prepared_request.rs (line 91)

85fn main() {
86    let mut target = [0_u8; MAX_REQUEST_TARGET_BYTES];
87    let mut body = [0_u8; 1];
88    let prepared = ListResources.prepare(PreparationStorage::new(&mut target, &mut body));
89    let Ok(prepared) = prepared else { return };
90
91    assert_eq!(prepared.transport_request().method(), Method::Get);
92    assert_eq!(prepared.metadata().impact(), OperationImpact::ReadOnly);
93    assert_eq!(prepared.response_policy().max_body_bytes(), 65_536);
94}

Source

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

Returns the validated origin-form target.

Examples found in repository ?

examples/provider_neutral.rs (line 13)

6fn main() {
7    let Ok(target) = RequestTarget::new("/resources?page=1") else {
8        return;
9    };
10    let request = TransportRequest::new(Method::Get, target);
11
12    assert_eq!(request.method(), Method::Get);
13    assert_eq!(request.target().as_str(), "/resources?page=1");
14    assert!(request.body().is_empty());
15}

Source

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

Returns the borrowed body bytes.

Examples found in repository ?

examples/provider_neutral.rs (line 14)

6fn main() {
7    let Ok(target) = RequestTarget::new("/resources?page=1") else {
8        return;
9    };
10    let request = TransportRequest::new(Method::Get, target);
11
12    assert_eq!(request.method(), Method::Get);
13    assert_eq!(request.target().as_str(), "/resources?page=1");
14    assert!(request.body().is_empty());
15}