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

69fn main() {
70    let mut target = [0_u8; MAX_REQUEST_TARGET_BYTES];
71    let mut body = [0_u8; 1];
72    let prepared = ListResources.prepare(PreparationStorage::new(&mut target, &mut body));
73    let Ok(prepared) = prepared else { return };
74
75    assert_eq!(prepared.transport_request().method(), Method::Get);
76    assert_eq!(prepared.metadata().impact(), OperationImpact::ReadOnly);
77    assert_eq!(prepared.response_policy().max_body_bytes(), 65_536);
78}

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

31    fn prepare<'storage>(
32        &self,
33        storage: PreparationStorage<'storage>,
34    ) -> Result<PreparedRequest<'storage>, Self::Error> {
35        let (target_storage, _body_storage) = storage.into_parts();
36        let target = target_storage
37            .get_mut(..17)
38            .ok_or(PrepareError::TargetBuffer)?;
39        target.copy_from_slice(b"/resources?page=1");
40        let target = core::str::from_utf8(target).map_err(|_| PrepareError::InvalidTarget)?;
41        let target = RequestTarget::new(target).map_err(|_| PrepareError::InvalidTarget)?;
42        let request = TransportRequest::new(Method::Get, target);
43        let metadata = OperationMetadata::new(
44            OperationImpact::ReadOnly,
45            RequestSemantics::Safe,
46            RetryEligibility::ExplicitPolicy,
47            CostIntent::NoKnownCost,
48        )
49        .map_err(|_| PrepareError::InvalidMetadata)?;
50        let response_policy = ResponsePolicy::new(
51            &OK_STATUS,
52            ContentTypePolicy::Required(&JSON_MEDIA),
53            ResponseBodyPolicy::Required,
54            65_536,
55        )
56        .map_err(|_| PrepareError::InvalidResponsePolicy)?;
57        let endpoint =
58            EndpointIdentity::new(EndpointScheme::Https, "api.example.invalid", 443, "/v1")
59                .map_err(|_| PrepareError::InvalidEndpoint)?;
60        Ok(PreparedRequest::new(
61            request,
62            ProviderService::new(Provider::Hetzner, ApiFamily::Cloud, endpoint),
63            metadata,
64            response_policy,
65        ))
66    }