Struct PreparedRequest

Source

pub struct PreparedRequest<'request> { /* private fields */ }

Expand description

Complete request, endpoint, operation metadata, and response policy.

Implementations§

Source §

impl<'request> PreparedRequest<'request>

Source

pub const fn new( request: TransportRequest<'request>, service: ProviderService<'request>, metadata: OperationMetadata, response_policy: ResponsePolicy, ) -> Self

Creates a complete prepared request without policy defaults.

Examples found in repository ?

examples/prepared_request.rs (lines 76-81)

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_operation_id(self, operation_id: OperationId) -> Self

Binds a validated provider operation identifier to this request.

Source

pub const fn transport_request(self) -> TransportRequest<'request>

Returns the validated transport request.

Examples found in repository ?

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 service(self) -> ProviderService<'request>

Returns the bound provider service.

Source

pub const fn metadata(self) -> OperationMetadata

Returns complete safety and retry metadata.

Examples found in repository ?

examples/prepared_request.rs (line 92)

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 response_policy(self) -> ResponsePolicy

Returns complete checked-response policy.

Examples found in repository ?

examples/prepared_request.rs (line 93)

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 operation_id(self) -> Option<OperationId>

Returns the provider operation identifier when one was bound.

Source

pub fn validate_response<'buffer>( self, response: ResponseBuffer<'buffer>, ) -> Result<CheckedResponseGuard<'buffer>, ResponsePolicyError>

Applies the complete prepared response policy without executing transport.

Source

pub fn apply_response_metadata_policy( self, response: &mut ResponseBuffer<'_>, ) -> Result<(), ResponsePolicyError>

Applies operation-owned metadata policy before provider error decoding.

This is the error-status counterpart to Self::validate_response. It extracts and protects, discards, or admits retention of the provider request identifier without applying success-status or body policy.

Source