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

112fn main() {
113    let mut target = [0_u8; MAX_REQUEST_TARGET_BYTES];
114    let mut body = [0_u8; 1];
115    let prepared = ListResources.prepare(PreparationStorage::new(&mut target, &mut body));
116    let Ok(prepared) = prepared else { return };
117
118    assert_eq!(prepared.transport_request().method(), Method::Get);
119    assert_eq!(prepared.metadata().impact(), OperationImpact::ReadOnly);
120    assert_eq!(prepared.response_policy().max_body_bytes(), 65_536);
121}

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

49    fn prepare<'storage>(
50        &self,
51        storage: PreparationStorage<'storage>,
52    ) -> Result<PreparedRequest<'storage>, Self::Error> {
53        let (target_storage, _body_storage) = storage.into_parts();
54        let target = target_storage
55            .get_mut(..17)
56            .ok_or(PrepareError::TargetBuffer)?;
57        target.copy_from_slice(b"/resources?page=1");
58        let target = core::str::from_utf8(target).map_err(|_| PrepareError::InvalidTarget)?;
59        let target = RequestTarget::new(target).map_err(|_| PrepareError::InvalidTarget)?;
60        let request = TransportRequest::new(Method::Get, target);
61        let metadata = OperationMetadata::new(
62            OperationImpact::ReadOnly,
63            RequestSemantics::Safe,
64            RetryEligibility::ExplicitPolicy,
65            CostIntent::NoKnownCost,
66            RequestIdPolicy::Protected,
67        )
68        .map_err(|_| PrepareError::InvalidMetadata)?;
69        let response_policy = ResponsePolicy::new(
70            &OK_STATUS,
71            ContentTypePolicy::Required(&JSON_MEDIA),
72            ResponseBodyPolicy::Required,
73            65_536,
74        )
75        .map_err(|_| PrepareError::InvalidResponsePolicy)?;
76        let endpoint =
77            EndpointIdentity::new(EndpointScheme::Https, "api.example.invalid", 443, "/v1")
78                .map_err(|_| PrepareError::InvalidEndpoint)?;
79        let authentication_policy = AuthenticationScopePolicy::new(
80            ScopeRequirement::Required(ExampleProvider::ID),
81            ScopeRequirement::Required(ComputeService::ID),
82            ScopeRequirement::Required(endpoint),
83            ScopeRequirement::Forbidden,
84            ScopeRequirement::Forbidden,
85            ScopeRequirement::Forbidden,
86        );
87        let content_type =
88            HeaderName::new("content-type").map_err(|_| PrepareError::InvalidRawResponsePolicy)?;
89        let request_id =
90            HeaderName::new("x-request-id").map_err(|_| PrepareError::InvalidRawResponsePolicy)?;
91        let raw_response_policy = RawResponsePolicy::new(
92            65_536,
93            65_536,
94            ResponseMediaPolicy::Required(&JSON_MEDIA),
95            ResponseMediaPolicy::Required(&JSON_MEDIA),
96            &[content_type, request_id],
97            8,
98        )
99        .map_err(|_| PrepareError::InvalidRawResponsePolicy)?;
100        PreparedRequest::new(
101            request,
102            ProviderService::from_marker::<ComputeService>(EndpointPolicy::fixed(endpoint)),
103            metadata,
104            response_policy,
105            authentication_policy,
106            raw_response_policy,
107        )
108        .map_err(|_| PrepareError::InvalidRawResponsePolicy)
109    }