Struct PreparationStorage

Source

pub struct PreparationStorage<'storage> { /* private fields */ }

Expand description

Caller-owned target and request-body storage supplied to preparation.

Implementations§

Source §

impl<'storage> PreparationStorage<'storage>

Source

pub const fn new(target: &'storage mut [u8], body: &'storage mut [u8]) -> Self

Creates complete caller-owned storage for one preparation attempt.

§Security

Preparation may write credentials or other secrets into body. A successful PreparedRequest must retain those bytes until transport use, so this wrapper cannot clear them on success. For secret-bearing operations, guard body with a volatile-clearing type such as cloud_sdk_sanitization::SecretBuffer and drop the guard immediately after transport use. A plain mutable slice is not cleared when the prepared request is dropped.

Examples found in repository ?

examples/prepared_request.rs (line 87)

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

Source

pub fn into_parts(self) -> (&'storage mut [u8], &'storage mut [u8])

Consumes the storage wrapper and returns both independent buffers.

Examples found in repository ?

examples/prepared_request.rs (line 50)

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        )
64        .map_err(|_| PrepareError::InvalidMetadata)?;
65        let response_policy = ResponsePolicy::new(
66            &OK_STATUS,
67            ContentTypePolicy::Required(&JSON_MEDIA),
68            ResponseBodyPolicy::Required,
69            65_536,
70        )
71        .map_err(|_| PrepareError::InvalidResponsePolicy)?;
72        let endpoint =
73            EndpointIdentity::new(EndpointScheme::Https, "api.example.invalid", 443, "/v1")
74                .map_err(|_| PrepareError::InvalidEndpoint)?;
75        Ok(PreparedRequest::new(
76            request,
77            ProviderService::from_marker::<ComputeService>(endpoint),
78            metadata,
79            response_policy,
80        ))
81    }