google_cloud_storage/storage/write_object.rs
1// Copyright 2025 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Contains the request builder for [write_object()] and related types.
16//!
17//! [write_object()]: crate::storage::client::Storage::write_object()
18
19use super::streaming_source::{Seek, StreamingSource};
20use super::*;
21use crate::model_ext::KeyAes256;
22use crate::storage::checksum::details::update as checksum_update;
23use crate::storage::checksum::details::{Checksum, Md5};
24use crate::storage::request_options::RequestOptions;
25
26/// A request builder for object writes.
27///
28/// # Example: hello world
29/// ```
30/// use google_cloud_storage::client::Storage;
31/// async fn sample(client: &Storage) -> anyhow::Result<()> {
32/// let response = client
33/// .write_object("projects/_/buckets/my-bucket", "hello", "Hello World!")
34/// .send_unbuffered()
35/// .await?;
36/// println!("response details={response:?}");
37/// Ok(())
38/// }
39/// ```
40///
41/// # Example: upload a file
42/// ```
43/// use google_cloud_storage::client::Storage;
44/// async fn sample(client: &Storage) -> anyhow::Result<()> {
45/// let payload = tokio::fs::File::open("my-data").await?;
46/// let response = client
47/// .write_object("projects/_/buckets/my-bucket", "my-object", payload)
48/// .send_unbuffered()
49/// .await?;
50/// println!("response details={response:?}");
51/// Ok(())
52/// }
53/// ```
54///
55/// # Example: create a new object from a custom data source
56/// ```
57/// use google_cloud_storage::{client::Storage, streaming_source::StreamingSource};
58/// struct DataSource;
59/// impl StreamingSource for DataSource {
60/// type Error = std::io::Error;
61/// async fn next(&mut self) -> Option<Result<bytes::Bytes, Self::Error>> {
62/// # panic!();
63/// }
64/// }
65///
66/// async fn sample(client: &Storage) -> anyhow::Result<()> {
67/// let response = client
68/// .write_object("projects/_/buckets/my-bucket", "my-object", DataSource)
69/// .send_buffered()
70/// .await?;
71/// println!("response details={response:?}");
72/// Ok(())
73/// }
74/// ```
75pub struct WriteObject<T, S = crate::storage::transport::Storage>
76where
77 S: crate::storage::stub::Storage + 'static,
78{
79 stub: std::sync::Arc<S>,
80 pub(crate) request: crate::model_ext::WriteObjectRequest,
81 pub(crate) payload: Payload<T>,
82 pub(crate) options: RequestOptions,
83}
84
85impl<T, S> WriteObject<T, S>
86where
87 S: crate::storage::stub::Storage + 'static,
88{
89 /// Set a [request precondition] on the object generation to match.
90 ///
91 /// With this precondition the request fails if the current object
92 /// generation matches the provided value. A common value is `0`, which
93 /// prevents writes from succeeding if the object already exists.
94 ///
95 /// # Example
96 /// ```
97 /// # use google_cloud_storage::client::Storage;
98 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
99 /// let response = client
100 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
101 /// .set_if_generation_match(0)
102 /// .send_buffered()
103 /// .await?;
104 /// println!("response details={response:?}");
105 /// # Ok(()) }
106 /// ```
107 ///
108 /// [request precondition]: https://cloud.google.com/storage/docs/request-preconditions
109 pub fn set_if_generation_match<V>(mut self, v: V) -> Self
110 where
111 V: Into<i64>,
112 {
113 self.request.spec.if_generation_match = Some(v.into());
114 self
115 }
116
117 /// Set a [request precondition] on the object generation to match.
118 ///
119 /// With this precondition the request fails if the current object
120 /// generation does not match the provided value.
121 ///
122 /// # Example
123 /// ```
124 /// # use google_cloud_storage::client::Storage;
125 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
126 /// let response = client
127 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
128 /// .set_if_generation_not_match(0)
129 /// .send_buffered()
130 /// .await?;
131 /// println!("response details={response:?}");
132 /// # Ok(()) }
133 /// ```
134 ///
135 /// [request precondition]: https://cloud.google.com/storage/docs/request-preconditions
136 pub fn set_if_generation_not_match<V>(mut self, v: V) -> Self
137 where
138 V: Into<i64>,
139 {
140 self.request.spec.if_generation_not_match = Some(v.into());
141 self
142 }
143
144 /// Set a [request precondition] on the object meta generation.
145 ///
146 /// With this precondition the request fails if the current object metadata
147 /// generation does not match the provided value. This may be useful to
148 /// prevent changes when the metageneration is known.
149 ///
150 /// # Example
151 /// ```
152 /// # use google_cloud_storage::client::Storage;
153 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
154 /// let response = client
155 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
156 /// .set_if_metageneration_match(1234)
157 /// .send_buffered()
158 /// .await?;
159 /// println!("response details={response:?}");
160 /// # Ok(()) }
161 /// ```
162 ///
163 /// [request precondition]: https://cloud.google.com/storage/docs/request-preconditions
164 pub fn set_if_metageneration_match<V>(mut self, v: V) -> Self
165 where
166 V: Into<i64>,
167 {
168 self.request.spec.if_metageneration_match = Some(v.into());
169 self
170 }
171
172 /// Set a [request precondition] on the object meta-generation.
173 ///
174 /// With this precondition the request fails if the current object metadata
175 /// generation matches the provided value. This is rarely useful in uploads,
176 /// it is more commonly used on reads to prevent a large response if the
177 /// data is already cached.
178 ///
179 /// # Example
180 /// ```
181 /// # use google_cloud_storage::client::Storage;
182 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
183 /// let response = client
184 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
185 /// .set_if_metageneration_not_match(1234)
186 /// .send_buffered()
187 /// .await?;
188 /// println!("response details={response:?}");
189 /// # Ok(()) }
190 /// ```
191 ///
192 /// [request precondition]: https://cloud.google.com/storage/docs/request-preconditions
193 pub fn set_if_metageneration_not_match<V>(mut self, v: V) -> Self
194 where
195 V: Into<i64>,
196 {
197 self.request.spec.if_metageneration_not_match = Some(v.into());
198 self
199 }
200
201 /// Sets the ACL for the new object.
202 ///
203 /// # Example
204 /// ```
205 /// # use google_cloud_storage::client::Storage;
206 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
207 /// # use google_cloud_storage::model::ObjectAccessControl;
208 /// let response = client
209 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
210 /// .set_acl([ObjectAccessControl::new().set_entity("allAuthenticatedUsers").set_role("READER")])
211 /// .send_buffered()
212 /// .await?;
213 /// println!("response details={response:?}");
214 /// # Ok(()) }
215 /// ```
216 pub fn set_acl<I, V>(mut self, v: I) -> Self
217 where
218 I: IntoIterator<Item = V>,
219 V: Into<crate::model::ObjectAccessControl>,
220 {
221 self.mut_resource().acl = v.into_iter().map(|a| a.into()).collect();
222 self
223 }
224
225 /// Sets the [cache control] for the new object.
226 ///
227 /// This can be used to control caching in [public objects].
228 ///
229 /// # Example
230 /// ```
231 /// # use google_cloud_storage::client::Storage;
232 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
233 /// let response = client
234 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
235 /// .set_cache_control("public; max-age=7200")
236 /// .send_buffered()
237 /// .await?;
238 /// println!("response details={response:?}");
239 /// # Ok(()) }
240 /// ```
241 ///
242 /// [public objects]: https://cloud.google.com/storage/docs/access-control/making-data-public
243 /// [cache control]: https://datatracker.ietf.org/doc/html/rfc7234#section-5.2
244 pub fn set_cache_control<V: Into<String>>(mut self, v: V) -> Self {
245 self.mut_resource().cache_control = v.into();
246 self
247 }
248
249 /// Sets the [content disposition] for the new object.
250 ///
251 /// Google Cloud Storage can serve content directly to web browsers. This
252 /// attribute sets the `Content-Disposition` header, which may change how
253 /// the browser displays the contents.
254 ///
255 /// # Example
256 /// ```
257 /// # use google_cloud_storage::client::Storage;
258 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
259 /// let response = client
260 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
261 /// .set_content_disposition("inline")
262 /// .send_buffered()
263 /// .await?;
264 /// println!("response details={response:?}");
265 /// # Ok(()) }
266 /// ```
267 ///
268 /// [content disposition]: https://datatracker.ietf.org/doc/html/rfc6266
269 pub fn set_content_disposition<V: Into<String>>(mut self, v: V) -> Self {
270 self.mut_resource().content_disposition = v.into();
271 self
272 }
273
274 /// Sets the [content encoding] for the object data.
275 ///
276 /// This can be used to upload compressed data and enable [transcoding] of
277 /// the data during reads.
278 ///
279 /// # Example
280 /// ```
281 /// # use google_cloud_storage::client::Storage;
282 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
283 /// use flate2::write::GzEncoder;
284 /// use std::io::Write;
285 /// let mut e = GzEncoder::new(Vec::new(), flate2::Compression::default());
286 /// e.write_all(b"hello world");
287 /// let response = client
288 /// .write_object("projects/_/buckets/my-bucket", "my-object", bytes::Bytes::from_owner(e.finish()?))
289 /// .set_content_encoding("gzip")
290 /// .send_buffered()
291 /// .await?;
292 /// println!("response details={response:?}");
293 /// # Ok(()) }
294 /// ```
295 ///
296 /// [transcoding]: https://cloud.google.com/storage/docs/transcoding
297 /// [content encoding]: https://datatracker.ietf.org/doc/html/rfc7231#section-3.1.2.2
298 pub fn set_content_encoding<V: Into<String>>(mut self, v: V) -> Self {
299 self.mut_resource().content_encoding = v.into();
300 self
301 }
302
303 /// Sets the [content language] for the new object.
304 ///
305 /// Google Cloud Storage can serve content directly to web browsers. This
306 /// attribute sets the `Content-Language` header, which may change how the
307 /// browser displays the contents.
308 ///
309 /// # Example
310 /// ```
311 /// # use google_cloud_storage::client::Storage;
312 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
313 /// let response = client
314 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
315 /// .set_content_language("en")
316 /// .send_buffered()
317 /// .await?;
318 /// println!("response details={response:?}");
319 /// # Ok(()) }
320 /// ```
321 ///
322 /// [content language]: https://cloud.google.com/storage/docs/metadata#content-language
323 pub fn set_content_language<V: Into<String>>(mut self, v: V) -> Self {
324 self.mut_resource().content_language = v.into();
325 self
326 }
327
328 /// Sets the [content type] for the new object.
329 ///
330 /// Google Cloud Storage can serve content directly to web browsers. This
331 /// attribute sets the `Content-Type` header, which may change how the
332 /// browser interprets the contents.
333 ///
334 /// # Example
335 /// ```
336 /// # use google_cloud_storage::client::Storage;
337 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
338 /// let response = client
339 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
340 /// .set_content_type("text/plain")
341 /// .send_buffered()
342 /// .await?;
343 /// println!("response details={response:?}");
344 /// # Ok(()) }
345 /// ```
346 ///
347 /// [content type]: https://datatracker.ietf.org/doc/html/rfc7231#section-3.1.1.5
348 pub fn set_content_type<V: Into<String>>(mut self, v: V) -> Self {
349 self.mut_resource().content_type = v.into();
350 self
351 }
352
353 /// Sets the [custom time] for the new object.
354 ///
355 /// This field is typically set in order to use the [DaysSinceCustomTime]
356 /// condition in Object Lifecycle Management.
357 ///
358 /// # Example
359 /// ```
360 /// # use google_cloud_storage::client::Storage;
361 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
362 /// let time = wkt::Timestamp::try_from("2025-07-07T18:30:00Z")?;
363 /// let response = client
364 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
365 /// .set_custom_time(time)
366 /// .send_buffered()
367 /// .await?;
368 /// println!("response details={response:?}");
369 /// # Ok(()) }
370 /// ```
371 ///
372 /// [DaysSinceCustomTime]: https://cloud.google.com/storage/docs/lifecycle#dayssincecustomtime
373 /// [custom time]: https://cloud.google.com/storage/docs/metadata#custom-time
374 pub fn set_custom_time<V: Into<wkt::Timestamp>>(mut self, v: V) -> Self {
375 self.mut_resource().custom_time = Some(v.into());
376 self
377 }
378
379 /// Sets the [event based hold] flag for the new object.
380 ///
381 /// This field is typically set in order to prevent objects from being
382 /// deleted or modified.
383 ///
384 /// # Example
385 /// ```
386 /// # use google_cloud_storage::client::Storage;
387 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
388 /// let response = client
389 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
390 /// .set_event_based_hold(true)
391 /// .send_buffered()
392 /// .await?;
393 /// println!("response details={response:?}");
394 /// # Ok(()) }
395 /// ```
396 ///
397 /// [event based hold]: https://cloud.google.com/storage/docs/object-holds
398 pub fn set_event_based_hold<V: Into<bool>>(mut self, v: V) -> Self {
399 self.mut_resource().event_based_hold = Some(v.into());
400 self
401 }
402
403 /// Sets the [custom metadata] for the new object.
404 ///
405 /// This field is typically set to annotate the object with
406 /// application-specific metadata.
407 ///
408 /// # Example
409 /// ```
410 /// # use google_cloud_storage::client::Storage;
411 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
412 /// let time = wkt::Timestamp::try_from("2025-07-07T18:30:00Z")?;
413 /// let response = client
414 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
415 /// .set_metadata([("test-only", "true"), ("environment", "qa")])
416 /// .send_buffered()
417 /// .await?;
418 /// println!("response details={response:?}");
419 /// # Ok(()) }
420 /// ```
421 ///
422 /// [custom metadata]: https://cloud.google.com/storage/docs/metadata#custom-metadata
423 pub fn set_metadata<I, K, V>(mut self, i: I) -> Self
424 where
425 I: IntoIterator<Item = (K, V)>,
426 K: Into<String>,
427 V: Into<String>,
428 {
429 self.mut_resource().metadata = i.into_iter().map(|(k, v)| (k.into(), v.into())).collect();
430 self
431 }
432
433 /// Sets the [retention configuration] for the new object.
434 ///
435 /// # Example
436 /// ```
437 /// # use google_cloud_storage::client::Storage;
438 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
439 /// # use google_cloud_storage::model::object::{Retention, retention};
440 /// let response = client
441 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
442 /// .set_retention(
443 /// Retention::new()
444 /// .set_mode(retention::Mode::Locked)
445 /// .set_retain_until_time(wkt::Timestamp::try_from("2035-01-01T00:00:00Z")?))
446 /// .send_buffered()
447 /// .await?;
448 /// println!("response details={response:?}");
449 /// # Ok(()) }
450 /// ```
451 ///
452 /// [retention configuration]: https://cloud.google.com/storage/docs/metadata#retention-config
453 pub fn set_retention<V>(mut self, v: V) -> Self
454 where
455 V: Into<crate::model::object::Retention>,
456 {
457 self.mut_resource().retention = Some(v.into());
458 self
459 }
460
461 /// Sets the [storage class] for the new object.
462 ///
463 /// # Example
464 /// ```
465 /// # use google_cloud_storage::client::Storage;
466 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
467 /// let response = client
468 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
469 /// .set_storage_class("ARCHIVE")
470 /// .send_buffered()
471 /// .await?;
472 /// println!("response details={response:?}");
473 /// # Ok(()) }
474 /// ```
475 ///
476 /// [storage class]: https://cloud.google.com/storage/docs/storage-classes
477 pub fn set_storage_class<V>(mut self, v: V) -> Self
478 where
479 V: Into<String>,
480 {
481 self.mut_resource().storage_class = v.into();
482 self
483 }
484
485 /// Sets the [temporary hold] flag for the new object.
486 ///
487 /// This field is typically set in order to prevent objects from being
488 /// deleted or modified.
489 ///
490 /// # Example
491 /// ```
492 /// # use google_cloud_storage::client::Storage;
493 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
494 /// let time = wkt::Timestamp::try_from("2025-07-07T18:30:00Z")?;
495 /// let response = client
496 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
497 /// .set_temporary_hold(true)
498 /// .send_buffered()
499 /// .await?;
500 /// println!("response details={response:?}");
501 /// # Ok(()) }
502 /// ```
503 ///
504 /// [temporary hold]: https://cloud.google.com/storage/docs/object-holds
505 pub fn set_temporary_hold<V: Into<bool>>(mut self, v: V) -> Self {
506 self.mut_resource().temporary_hold = v.into();
507 self
508 }
509
510 /// Sets the resource name of the [Customer-managed encryption key] for this
511 /// object.
512 ///
513 /// The service imposes a number of restrictions on the keys used to encrypt
514 /// Google Cloud Storage objects. Read the documentation in full before
515 /// trying to use customer-managed encryption keys. In particular, verify
516 /// the service has the necessary permissions, and the key is in a
517 /// compatible location.
518 ///
519 /// # Example
520 /// ```
521 /// # use google_cloud_storage::client::Storage;
522 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
523 /// let response = client
524 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
525 /// .set_kms_key("projects/test-project/locations/us-central1/keyRings/test-ring/cryptoKeys/test-key")
526 /// .send_buffered()
527 /// .await?;
528 /// println!("response details={response:?}");
529 /// # Ok(()) }
530 /// ```
531 ///
532 /// [Customer-managed encryption key]: https://cloud.google.com/storage/docs/encryption/customer-managed-keys
533 pub fn set_kms_key<V>(mut self, v: V) -> Self
534 where
535 V: Into<String>,
536 {
537 self.mut_resource().kms_key = v.into();
538 self
539 }
540
541 /// Configure this object to use one of the [predefined ACLs].
542 ///
543 /// # Example
544 /// ```
545 /// # use google_cloud_storage::client::Storage;
546 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
547 /// let response = client
548 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
549 /// .set_predefined_acl("private")
550 /// .send_buffered()
551 /// .await?;
552 /// println!("response details={response:?}");
553 /// # Ok(()) }
554 /// ```
555 ///
556 /// [predefined ACLs]: https://cloud.google.com/storage/docs/access-control/lists#predefined-acl
557 pub fn set_predefined_acl<V>(mut self, v: V) -> Self
558 where
559 V: Into<String>,
560 {
561 self.request.spec.predefined_acl = v.into();
562 self
563 }
564
565 /// The encryption key used with the Customer-Supplied Encryption Keys
566 /// feature. In raw bytes format (not base64-encoded).
567 ///
568 /// # Example
569 /// ```
570 /// # use google_cloud_storage::client::Storage;
571 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
572 /// # use google_cloud_storage::model_ext::KeyAes256;
573 /// let key: &[u8] = &[97; 32];
574 /// let response = client
575 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
576 /// .set_key(KeyAes256::new(key)?)
577 /// .send_buffered()
578 /// .await?;
579 /// println!("response details={response:?}");
580 /// # Ok(()) }
581 /// ```
582 pub fn set_key(mut self, v: KeyAes256) -> Self {
583 self.request.params = Some(v.into());
584 self
585 }
586
587 /// Configure the idempotency for this upload.
588 ///
589 /// By default, the client library treats single-shot uploads without
590 /// preconditions, as non-idempotent. If the destination bucket is
591 /// configured with [object versioning] then the operation may succeed
592 /// multiple times with observable side-effects. With object versioning and
593 /// a [lifecycle] policy limiting the number of versions, uploading the same
594 /// data multiple times may result in data loss.
595 ///
596 /// The client library cannot efficiently determine if these conditions
597 /// apply to your upload. If they do, or your application can tolerate
598 /// multiple versions of the same data for other reasons, consider using
599 /// `with_idempotency(true)`.
600 ///
601 /// The client library treats resumable uploads as idempotent, regardless of
602 /// the value in this option. Such uploads can succeed at most once.
603 ///
604 /// # Example
605 /// ```
606 /// # use google_cloud_storage::client::Storage;
607 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
608 /// use std::time::Duration;
609 /// use gax::retry_policy::RetryPolicyExt;
610 /// let response = client
611 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
612 /// .with_idempotency(true)
613 /// .send_buffered()
614 /// .await?;
615 /// println!("response details={response:?}");
616 /// # Ok(()) }
617 /// ```
618 ///
619 /// [lifecycle]: https://cloud.google.com/storage/docs/lifecycle
620 /// [object versioning]: https://cloud.google.com/storage/docs/object-versioning
621 pub fn with_idempotency(mut self, v: bool) -> Self {
622 self.options.idempotency = Some(v);
623 self
624 }
625
626 /// The retry policy used for this request.
627 ///
628 /// # Example
629 /// ```
630 /// # use google_cloud_storage::client::Storage;
631 /// # use google_cloud_storage::retry_policy::RetryableErrors;
632 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
633 /// use std::time::Duration;
634 /// use gax::retry_policy::RetryPolicyExt;
635 /// let response = client
636 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
637 /// .with_retry_policy(
638 /// RetryableErrors
639 /// .with_attempt_limit(5)
640 /// .with_time_limit(Duration::from_secs(90)),
641 /// )
642 /// .send_buffered()
643 /// .await?;
644 /// println!("response details={response:?}");
645 /// # Ok(()) }
646 /// ```
647 pub fn with_retry_policy<V: Into<gax::retry_policy::RetryPolicyArg>>(mut self, v: V) -> Self {
648 self.options.retry_policy = v.into().into();
649 self
650 }
651
652 /// The backoff policy used for this request.
653 ///
654 /// # Example
655 /// ```
656 /// # use google_cloud_storage::client::Storage;
657 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
658 /// use std::time::Duration;
659 /// use gax::exponential_backoff::ExponentialBackoff;
660 /// let response = client
661 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
662 /// .with_backoff_policy(ExponentialBackoff::default())
663 /// .send_buffered()
664 /// .await?;
665 /// println!("response details={response:?}");
666 /// # Ok(()) }
667 /// ```
668 pub fn with_backoff_policy<V: Into<gax::backoff_policy::BackoffPolicyArg>>(
669 mut self,
670 v: V,
671 ) -> Self {
672 self.options.backoff_policy = v.into().into();
673 self
674 }
675
676 /// The retry throttler used for this request.
677 ///
678 /// Most of the time you want to use the same throttler for all the requests
679 /// in a client, and even the same throttler for many clients. Rarely it
680 /// may be necessary to use an custom throttler for some subset of the
681 /// requests.
682 ///
683 /// # Example
684 /// ```
685 /// # use google_cloud_storage::client::Storage;
686 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
687 /// let response = client
688 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
689 /// .with_retry_throttler(adhoc_throttler())
690 /// .send_buffered()
691 /// .await?;
692 /// println!("response details={response:?}");
693 /// fn adhoc_throttler() -> gax::retry_throttler::SharedRetryThrottler {
694 /// # panic!();
695 /// }
696 /// # Ok(()) }
697 /// ```
698 pub fn with_retry_throttler<V: Into<gax::retry_throttler::RetryThrottlerArg>>(
699 mut self,
700 v: V,
701 ) -> Self {
702 self.options.retry_throttler = v.into().into();
703 self
704 }
705
706 /// Sets the payload size threshold to switch from single-shot to resumable uploads.
707 ///
708 /// # Example
709 /// ```
710 /// # use google_cloud_storage::client::Storage;
711 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
712 /// let response = client
713 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
714 /// .with_resumable_upload_threshold(0_usize) // Forces a resumable upload.
715 /// .send_buffered()
716 /// .await?;
717 /// println!("response details={response:?}");
718 /// # Ok(()) }
719 /// ```
720 ///
721 /// The client library can perform uploads using [single-shot] or
722 /// [resumable] uploads. For small objects, single-shot uploads offer better
723 /// performance, as they require a single HTTP transfer. For larger objects,
724 /// the additional request latency is not significant, and resumable uploads
725 /// offer better recovery on errors.
726 ///
727 /// The library automatically selects resumable uploads when the payload is
728 /// equal to or larger than this option. For smaller uploads the client
729 /// library uses single-shot uploads.
730 ///
731 /// The exact threshold depends on where the application is deployed and
732 /// destination bucket location with respect to where the application is
733 /// running. The library defaults should work well in most cases, but some
734 /// applications may benefit from fine-tuning.
735 ///
736 /// [single-shot]: https://cloud.google.com/storage/docs/uploading-objects
737 /// [resumable]: https://cloud.google.com/storage/docs/resumable-uploads
738 pub fn with_resumable_upload_threshold<V: Into<usize>>(mut self, v: V) -> Self {
739 self.options.resumable_upload_threshold = v.into();
740 self
741 }
742
743 /// Changes the buffer size for some resumable uploads.
744 ///
745 /// # Example
746 /// ```
747 /// # use google_cloud_storage::client::Storage;
748 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
749 /// let response = client
750 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
751 /// .with_resumable_upload_buffer_size(32 * 1024 * 1024_usize)
752 /// .send_buffered()
753 /// .await?;
754 /// println!("response details={response:?}");
755 /// # Ok(()) }
756 /// ```
757 ///
758 /// When performing [resumable uploads] from sources without [Seek] the
759 /// client library needs to buffer data in memory until it is persisted by
760 /// the service. Otherwise the data would be lost if the upload fails.
761 /// Applications may want to tune this buffer size:
762 ///
763 /// - Use smaller buffer sizes to support more concurrent uploads in the
764 /// same application.
765 /// - Use larger buffer sizes for better throughput. Sending many small
766 /// buffers stalls the upload until the client receives a successful
767 /// response from the service.
768 ///
769 /// Keep in mind that there are diminishing returns on using larger buffers.
770 ///
771 /// [resumable uploads]: https://cloud.google.com/storage/docs/resumable-uploads
772 /// [Seek]: crate::streaming_source::Seek
773 pub fn with_resumable_upload_buffer_size<V: Into<usize>>(mut self, v: V) -> Self {
774 self.options.resumable_upload_buffer_size = v.into();
775 self
776 }
777
778 fn mut_resource(&mut self) -> &mut crate::model::Object {
779 self.request
780 .spec
781 .resource
782 .as_mut()
783 .expect("resource field initialized in `new()`")
784 }
785
786 fn set_crc32c<V: Into<u32>>(mut self, v: V) -> Self {
787 let checksum = self.mut_resource().checksums.get_or_insert_default();
788 checksum.crc32c = Some(v.into());
789 self
790 }
791
792 pub fn set_md5_hash<I, V>(mut self, i: I) -> Self
793 where
794 I: IntoIterator<Item = V>,
795 V: Into<u8>,
796 {
797 let checksum = self.mut_resource().checksums.get_or_insert_default();
798 checksum.md5_hash = i.into_iter().map(|v| v.into()).collect();
799 self
800 }
801
802 /// Provide a precomputed value for the CRC32C checksum.
803 ///
804 /// # Example
805 /// ```
806 /// # use google_cloud_storage::client::Storage;
807 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
808 /// use crc32c::crc32c;
809 /// let response = client
810 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
811 /// .with_known_crc32c(crc32c(b"hello world"))
812 /// .send_buffered()
813 /// .await?;
814 /// println!("response details={response:?}");
815 /// # Ok(()) }
816 /// ```
817 ///
818 /// In some applications, the payload's CRC32C checksum is already known.
819 /// For example, the application may be reading the data from another blob
820 /// storage system.
821 ///
822 /// In such cases, it is safer to pass the known CRC32C of the payload to
823 /// [Cloud Storage], and more efficient to skip the computation in the
824 /// client library.
825 ///
826 /// Note that once you provide a CRC32C value to this builder you cannot
827 /// use [compute_md5()] to also have the library compute the checksums.
828 ///
829 /// [compute_md5()]: WriteObject::compute_md5
830 pub fn with_known_crc32c<V: Into<u32>>(self, v: V) -> Self {
831 let mut this = self;
832 this.options.checksum.crc32c = None;
833 this.set_crc32c(v)
834 }
835
836 /// Provide a precomputed value for the MD5 hash.
837 ///
838 /// # Example
839 /// ```
840 /// # use google_cloud_storage::client::Storage;
841 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
842 /// use md5::compute;
843 /// let hash = md5::compute(b"hello world");
844 /// let response = client
845 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
846 /// .with_known_md5_hash(bytes::Bytes::from_owner(hash.0))
847 /// .send_buffered()
848 /// .await?;
849 /// println!("response details={response:?}");
850 /// # Ok(()) }
851 /// ```
852 ///
853 /// In some applications, the payload's MD5 hash is already known. For
854 /// example, the application may be reading the data from another blob
855 /// storage system.
856 ///
857 /// In such cases, it is safer to pass the known MD5 of the payload to
858 /// [Cloud Storage], and more efficient to skip the computation in the
859 /// client library.
860 ///
861 /// Note that once you provide a MD5 value to this builder you cannot
862 /// use [compute_md5()] to also have the library compute the checksums.
863 ///
864 /// [compute_md5()]: WriteObject::compute_md5
865 pub fn with_known_md5_hash<I, V>(self, i: I) -> Self
866 where
867 I: IntoIterator<Item = V>,
868 V: Into<u8>,
869 {
870 let mut this = self;
871 this.options.checksum.md5_hash = None;
872 this.set_md5_hash(i)
873 }
874
875 /// Enables computation of MD5 hashes.
876 ///
877 /// # Example
878 /// ```
879 /// # use google_cloud_storage::client::Storage;
880 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
881 /// let payload = tokio::fs::File::open("my-data").await?;
882 /// let response = client
883 /// .write_object("projects/_/buckets/my-bucket", "my-object", payload)
884 /// .compute_md5()
885 /// .send_buffered()
886 /// .await?;
887 /// println!("response details={response:?}");
888 /// # Ok(()) }
889 /// ```
890 ///
891 /// See [precompute_checksums][WriteObject::precompute_checksums] for more
892 /// details on how checksums are used by the client library and their
893 /// limitations.
894 pub fn compute_md5(self) -> Self {
895 let mut this = self;
896 this.options.checksum.md5_hash = Some(Md5::default());
897 this
898 }
899
900 pub(crate) fn new<B, O, P>(
901 stub: std::sync::Arc<S>,
902 bucket: B,
903 object: O,
904 payload: P,
905 options: RequestOptions,
906 ) -> Self
907 where
908 B: Into<String>,
909 O: Into<String>,
910 P: Into<Payload<T>>,
911 {
912 let resource = crate::model::Object::new()
913 .set_bucket(bucket)
914 .set_name(object);
915 WriteObject {
916 stub,
917 request: crate::model_ext::WriteObjectRequest {
918 spec: crate::model::WriteObjectSpec::new().set_resource(resource),
919 params: None,
920 },
921 payload: payload.into(),
922 options,
923 }
924 }
925}
926
927impl<T, S> WriteObject<T, S>
928where
929 T: StreamingSource + Seek + Send + Sync + 'static,
930 <T as StreamingSource>::Error: std::error::Error + Send + Sync + 'static,
931 <T as Seek>::Error: std::error::Error + Send + Sync + 'static,
932 S: crate::storage::stub::Storage + 'static,
933{
934 /// A simple upload from a buffer.
935 ///
936 /// # Example
937 /// ```
938 /// # use google_cloud_storage::client::Storage;
939 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
940 /// let response = client
941 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
942 /// .send_unbuffered()
943 /// .await?;
944 /// println!("response details={response:?}");
945 /// # Ok(()) }
946 /// ```
947 pub async fn send_unbuffered(self) -> Result<Object> {
948 self.stub
949 .write_object_unbuffered(self.payload, self.request, self.options)
950 .await
951 }
952
953 /// Precompute the payload checksums before uploading the data.
954 ///
955 /// If the checksums are known when the upload starts, the client library
956 /// can include the checksums with the upload request, and the service can
957 /// reject the upload if the payload and the checksums do not match.
958 ///
959 /// # Example
960 /// ```
961 /// # use google_cloud_storage::client::Storage;
962 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
963 /// let payload = tokio::fs::File::open("my-data").await?;
964 /// let response = client
965 /// .write_object("projects/_/buckets/my-bucket", "my-object", payload)
966 /// .precompute_checksums()
967 /// .await?
968 /// .send_unbuffered()
969 /// .await?;
970 /// println!("response details={response:?}");
971 /// # Ok(()) }
972 /// ```
973 ///
974 /// Precomputing the checksums can be expensive if the data source is slow
975 /// to read. Therefore, the client library does not precompute the checksums
976 /// by default. The client library compares the checksums computed by the
977 /// service against its own checksums. If they do not match, the client
978 /// library returns an error. However, the service has already created the
979 /// object with the (likely incorrect) data.
980 ///
981 /// The client library currently uses the [JSON API], it is not possible to
982 /// send the checksums at the end of the upload with this API.
983 ///
984 /// [JSON API]: https://cloud.google.com/storage/docs/json_api
985 pub async fn precompute_checksums(mut self) -> Result<Self> {
986 let mut offset = 0_u64;
987 self.payload.seek(offset).await.map_err(Error::ser)?;
988 while let Some(n) = self.payload.next().await.transpose().map_err(Error::ser)? {
989 self.options.checksum.update(offset, &n);
990 offset += n.len() as u64;
991 }
992 self.payload.seek(0_u64).await.map_err(Error::ser)?;
993 let computed = self.options.checksum.finalize();
994 let current = self.mut_resource().checksums.get_or_insert_default();
995 checksum_update(current, computed);
996 self.options.checksum = Checksum {
997 crc32c: None,
998 md5_hash: None,
999 };
1000 Ok(self)
1001 }
1002}
1003
1004impl<T, S> WriteObject<T, S>
1005where
1006 T: StreamingSource + Send + Sync + 'static,
1007 T::Error: std::error::Error + Send + Sync + 'static,
1008 S: crate::storage::stub::Storage + 'static,
1009{
1010 /// Upload an object from a streaming source without rewinds.
1011 ///
1012 /// If the data source does **not** implement [Seek] the client library must
1013 /// buffer data sent to the service until the service confirms it has
1014 /// persisted the data. This requires more memory in the client, and when
1015 /// the buffer grows too large, may require stalling the writer until the
1016 /// service can persist the data.
1017 ///
1018 /// Use this function for data sources where it is expensive or impossible
1019 /// to restart the data source. This function is also useful when it is hard
1020 /// or impossible to predict the number of bytes emitted by a stream, even
1021 /// if restarting the stream is not too expensive.
1022 ///
1023 /// # Example
1024 /// ```
1025 /// # use google_cloud_storage::client::Storage;
1026 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
1027 /// let response = client
1028 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
1029 /// .send_buffered()
1030 /// .await?;
1031 /// println!("response details={response:?}");
1032 /// # Ok(()) }
1033 /// ```
1034 pub async fn send_buffered(self) -> crate::Result<Object> {
1035 self.stub
1036 .write_object_buffered(self.payload, self.request, self.options)
1037 .await
1038 }
1039}
1040
1041// We need `Debug` to use `expect_err()` in `Result<WriteObject, ...>`.
1042impl<T, S> std::fmt::Debug for WriteObject<T, S>
1043where
1044 S: crate::storage::stub::Storage + 'static,
1045{
1046 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1047 f.debug_struct("WriteObject")
1048 .field("stub", &self.stub)
1049 .field("request", &self.request)
1050 // skip payload, as it is not `Debug`
1051 .field("options", &self.options)
1052 .finish()
1053 }
1054}
1055
1056#[cfg(test)]
1057mod tests {
1058 use super::client::tests::{test_builder, test_inner_client};
1059 use super::*;
1060 use crate::client::Storage;
1061 use crate::model::{ObjectChecksums, WriteObjectSpec};
1062 use crate::storage::checksum::details::{Crc32c, Md5};
1063 use crate::streaming_source::tests::MockSeekSource;
1064 use auth::credentials::anonymous::Builder as Anonymous;
1065 use std::error::Error as _;
1066 use std::io::{Error as IoError, ErrorKind};
1067
1068 type Result = anyhow::Result<()>;
1069
1070 // Verify `write_object()` can be used with a source that implements
1071 // `StreamingSource` **and** `Seek`
1072 #[tokio::test]
1073 async fn test_upload_streaming_source_and_seek() -> Result {
1074 struct Source;
1075 impl crate::streaming_source::StreamingSource for Source {
1076 type Error = std::io::Error;
1077 async fn next(&mut self) -> Option<std::result::Result<bytes::Bytes, Self::Error>> {
1078 None
1079 }
1080 }
1081 impl crate::streaming_source::Seek for Source {
1082 type Error = std::io::Error;
1083 async fn seek(&mut self, _offset: u64) -> std::result::Result<(), Self::Error> {
1084 Ok(())
1085 }
1086 }
1087
1088 let client = Storage::builder()
1089 .with_credentials(Anonymous::new().build())
1090 .build()
1091 .await?;
1092 let _ = client.write_object("projects/_/buckets/test-bucket", "test-object", Source);
1093 Ok(())
1094 }
1095
1096 // Verify `write_object()` can be used with a source that **only**
1097 // implements `StreamingSource`.
1098 #[tokio::test]
1099 async fn test_upload_only_streaming_source() -> Result {
1100 struct Source;
1101 impl crate::streaming_source::StreamingSource for Source {
1102 type Error = std::io::Error;
1103 async fn next(&mut self) -> Option<std::result::Result<bytes::Bytes, Self::Error>> {
1104 None
1105 }
1106 }
1107
1108 let client = Storage::builder()
1109 .with_credentials(Anonymous::new().build())
1110 .build()
1111 .await?;
1112 let _ = client.write_object("projects/_/buckets/test-bucket", "test-object", Source);
1113 Ok(())
1114 }
1115
1116 // Verify `write_object()` meets normal Send, Sync, requirements.
1117 #[tokio::test]
1118 async fn test_upload_is_send_and_static() -> Result {
1119 let client = Storage::builder()
1120 .with_credentials(Anonymous::new().build())
1121 .build()
1122 .await?;
1123
1124 fn need_send<T: Send>(_val: &T) {}
1125 fn need_sync<T: Sync>(_val: &T) {}
1126 fn need_static<T: 'static>(_val: &T) {}
1127
1128 let upload = client.write_object("projects/_/buckets/test-bucket", "test-object", "");
1129 need_send(&upload);
1130 need_sync(&upload);
1131 need_static(&upload);
1132
1133 let upload = client
1134 .write_object("projects/_/buckets/test-bucket", "test-object", "")
1135 .send_unbuffered();
1136 need_send(&upload);
1137 need_static(&upload);
1138
1139 let upload = client
1140 .write_object("projects/_/buckets/test-bucket", "test-object", "")
1141 .send_buffered();
1142 need_send(&upload);
1143 need_static(&upload);
1144
1145 Ok(())
1146 }
1147
1148 #[test]
1149 fn upload_object_unbuffered_metadata() -> Result {
1150 use crate::model::ObjectAccessControl;
1151 let inner = test_inner_client(test_builder());
1152 let options = inner.options.clone();
1153 let stub = crate::storage::transport::Storage::new(inner);
1154 let mut builder =
1155 WriteObject::new(stub, "projects/_/buckets/bucket", "object", "", options)
1156 .set_if_generation_match(10)
1157 .set_if_generation_not_match(20)
1158 .set_if_metageneration_match(30)
1159 .set_if_metageneration_not_match(40)
1160 .set_predefined_acl("private")
1161 .set_acl([ObjectAccessControl::new()
1162 .set_entity("allAuthenticatedUsers")
1163 .set_role("READER")])
1164 .set_cache_control("public; max-age=7200")
1165 .set_content_disposition("inline")
1166 .set_content_encoding("gzip")
1167 .set_content_language("en")
1168 .set_content_type("text/plain")
1169 .set_custom_time(wkt::Timestamp::try_from("2025-07-07T18:11:00Z")?)
1170 .set_event_based_hold(true)
1171 .set_metadata([("k0", "v0"), ("k1", "v1")])
1172 .set_retention(
1173 crate::model::object::Retention::new()
1174 .set_mode(crate::model::object::retention::Mode::Locked)
1175 .set_retain_until_time(wkt::Timestamp::try_from("2035-07-07T18:14:00Z")?),
1176 )
1177 .set_storage_class("ARCHIVE")
1178 .set_temporary_hold(true)
1179 .set_kms_key("test-key")
1180 .with_known_crc32c(crc32c::crc32c(b""))
1181 .with_known_md5_hash(md5::compute(b"").0);
1182
1183 let resource = builder.request.spec.resource.take().unwrap();
1184 let builder = builder;
1185 assert_eq!(
1186 &builder.request.spec,
1187 &WriteObjectSpec::new()
1188 .set_if_generation_match(10)
1189 .set_if_generation_not_match(20)
1190 .set_if_metageneration_match(30)
1191 .set_if_metageneration_not_match(40)
1192 .set_predefined_acl("private")
1193 );
1194
1195 assert_eq!(
1196 resource,
1197 Object::new()
1198 .set_name("object")
1199 .set_bucket("projects/_/buckets/bucket")
1200 .set_acl([ObjectAccessControl::new()
1201 .set_entity("allAuthenticatedUsers")
1202 .set_role("READER")])
1203 .set_cache_control("public; max-age=7200")
1204 .set_content_disposition("inline")
1205 .set_content_encoding("gzip")
1206 .set_content_language("en")
1207 .set_content_type("text/plain")
1208 .set_checksums(
1209 crate::model::ObjectChecksums::new()
1210 .set_crc32c(crc32c::crc32c(b""))
1211 .set_md5_hash(bytes::Bytes::from_iter(md5::compute(b"").0))
1212 )
1213 .set_custom_time(wkt::Timestamp::try_from("2025-07-07T18:11:00Z")?)
1214 .set_event_based_hold(true)
1215 .set_metadata([("k0", "v0"), ("k1", "v1")])
1216 .set_retention(
1217 crate::model::object::Retention::new()
1218 .set_mode("LOCKED")
1219 .set_retain_until_time(wkt::Timestamp::try_from("2035-07-07T18:14:00Z")?)
1220 )
1221 .set_storage_class("ARCHIVE")
1222 .set_temporary_hold(true)
1223 .set_kms_key("test-key")
1224 );
1225
1226 Ok(())
1227 }
1228
1229 #[test]
1230 fn upload_object_options() {
1231 let inner = test_inner_client(
1232 test_builder()
1233 .with_resumable_upload_threshold(123_usize)
1234 .with_resumable_upload_buffer_size(234_usize),
1235 );
1236 let options = inner.options.clone();
1237 let stub = crate::storage::transport::Storage::new(inner);
1238 let request = WriteObject::new(
1239 stub.clone(),
1240 "projects/_/buckets/bucket",
1241 "object",
1242 "",
1243 options.clone(),
1244 );
1245 assert_eq!(request.options.resumable_upload_threshold, 123);
1246 assert_eq!(request.options.resumable_upload_buffer_size, 234);
1247
1248 let request = WriteObject::new(stub, "projects/_/buckets/bucket", "object", "", options)
1249 .with_resumable_upload_threshold(345_usize)
1250 .with_resumable_upload_buffer_size(456_usize);
1251 assert_eq!(request.options.resumable_upload_threshold, 345);
1252 assert_eq!(request.options.resumable_upload_buffer_size, 456);
1253 }
1254
1255 const QUICK: &str = "the quick brown fox jumps over the lazy dog";
1256 const VEXING: &str = "how vexingly quick daft zebras jump";
1257
1258 fn quick_checksum(mut engine: Checksum) -> ObjectChecksums {
1259 engine.update(0, &bytes::Bytes::from_static(QUICK.as_bytes()));
1260 engine.finalize()
1261 }
1262
1263 async fn collect<S: StreamingSource>(mut stream: S) -> anyhow::Result<Vec<u8>> {
1264 let mut collected = Vec::new();
1265 while let Some(b) = stream.next().await.transpose()? {
1266 collected.extend_from_slice(&b);
1267 }
1268 Ok(collected)
1269 }
1270
1271 #[tokio::test]
1272 async fn checksum_default() -> Result {
1273 let client = test_builder().build().await?;
1274 let upload = client
1275 .write_object("my-bucket", "my-object", QUICK)
1276 .precompute_checksums()
1277 .await?;
1278 let want = quick_checksum(Checksum {
1279 crc32c: Some(Crc32c::default()),
1280 md5_hash: None,
1281 });
1282 assert_eq!(
1283 upload.request.spec.resource.and_then(|r| r.checksums),
1284 Some(want)
1285 );
1286 let collected = collect(upload.payload).await?;
1287 assert_eq!(collected, QUICK.as_bytes());
1288 Ok(())
1289 }
1290
1291 #[tokio::test]
1292 async fn checksum_md5_and_crc32c() -> Result {
1293 let client = test_builder().build().await?;
1294 let upload = client
1295 .write_object("my-bucket", "my-object", QUICK)
1296 .compute_md5()
1297 .precompute_checksums()
1298 .await?;
1299 let want = quick_checksum(Checksum {
1300 crc32c: Some(Crc32c::default()),
1301 md5_hash: Some(Md5::default()),
1302 });
1303 assert_eq!(
1304 upload.request.spec.resource.and_then(|r| r.checksums),
1305 Some(want)
1306 );
1307 Ok(())
1308 }
1309
1310 #[tokio::test]
1311 async fn checksum_precomputed() -> Result {
1312 let mut engine = Checksum {
1313 crc32c: Some(Crc32c::default()),
1314 md5_hash: Some(Md5::default()),
1315 };
1316 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1317 let ck = engine.finalize();
1318
1319 let client = test_builder().build().await?;
1320 let upload = client
1321 .write_object("my-bucket", "my-object", QUICK)
1322 .with_known_crc32c(ck.crc32c.unwrap())
1323 .with_known_md5_hash(ck.md5_hash.clone())
1324 .precompute_checksums()
1325 .await?;
1326 // Note that the checksums do not match the data. This is intentional,
1327 // we are trying to verify that whatever is provided in with_crc32c()
1328 // and with_md5() is respected.
1329 assert_eq!(
1330 upload.request.spec.resource.and_then(|r| r.checksums),
1331 Some(ck)
1332 );
1333
1334 Ok(())
1335 }
1336
1337 #[tokio::test]
1338 async fn checksum_crc32c_known_md5_computed() -> Result {
1339 let mut engine = Checksum {
1340 crc32c: Some(Crc32c::default()),
1341 md5_hash: Some(Md5::default()),
1342 };
1343 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1344 let ck = engine.finalize();
1345
1346 let client = test_builder().build().await?;
1347 let upload = client
1348 .write_object("my-bucket", "my-object", QUICK)
1349 .compute_md5()
1350 .with_known_crc32c(ck.crc32c.unwrap())
1351 .precompute_checksums()
1352 .await?;
1353 // Note that the checksums do not match the data. This is intentional,
1354 // we are trying to verify that whatever is provided in with_known*()
1355 // is respected.
1356 let want = quick_checksum(Checksum {
1357 crc32c: None,
1358 md5_hash: Some(Md5::default()),
1359 })
1360 .set_crc32c(ck.crc32c.unwrap());
1361 assert_eq!(
1362 upload.request.spec.resource.and_then(|r| r.checksums),
1363 Some(want)
1364 );
1365
1366 Ok(())
1367 }
1368
1369 #[tokio::test]
1370 async fn checksum_mixed_then_precomputed() -> Result {
1371 let mut engine = Checksum {
1372 crc32c: Some(Crc32c::default()),
1373 md5_hash: Some(Md5::default()),
1374 };
1375 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1376 let ck = engine.finalize();
1377
1378 let client = test_builder().build().await?;
1379 let upload = client
1380 .write_object("my-bucket", "my-object", QUICK)
1381 .with_known_md5_hash(ck.md5_hash.clone())
1382 .with_known_crc32c(ck.crc32c.unwrap())
1383 .precompute_checksums()
1384 .await?;
1385 // Note that the checksums do not match the data. This is intentional,
1386 // we are trying to verify that whatever is provided in with_known*()
1387 // is respected.
1388 let want = ck.clone();
1389 assert_eq!(
1390 upload.request.spec.resource.and_then(|r| r.checksums),
1391 Some(want)
1392 );
1393
1394 Ok(())
1395 }
1396
1397 #[tokio::test]
1398 async fn checksum_full_computed_then_md5_precomputed() -> Result {
1399 let mut engine = Checksum {
1400 crc32c: Some(Crc32c::default()),
1401 md5_hash: Some(Md5::default()),
1402 };
1403 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1404 let ck = engine.finalize();
1405
1406 let client = test_builder().build().await?;
1407 let upload = client
1408 .write_object("my-bucket", "my-object", QUICK)
1409 .compute_md5()
1410 .with_known_md5_hash(ck.md5_hash.clone())
1411 .precompute_checksums()
1412 .await?;
1413 // Note that the checksums do not match the data. This is intentional,
1414 // we are trying to verify that whatever is provided in with_known*()
1415 // is respected.
1416 let want = quick_checksum(Checksum {
1417 crc32c: Some(Crc32c::default()),
1418 md5_hash: None,
1419 })
1420 .set_md5_hash(ck.md5_hash.clone());
1421 assert_eq!(
1422 upload.request.spec.resource.and_then(|r| r.checksums),
1423 Some(want)
1424 );
1425
1426 Ok(())
1427 }
1428
1429 #[tokio::test]
1430 async fn checksum_known_crc32_then_computed_md5() -> Result {
1431 let mut engine = Checksum {
1432 crc32c: Some(Crc32c::default()),
1433 md5_hash: Some(Md5::default()),
1434 };
1435 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1436 let ck = engine.finalize();
1437
1438 let client = test_builder().build().await?;
1439 let upload = client
1440 .write_object("my-bucket", "my-object", QUICK)
1441 .with_known_crc32c(ck.crc32c.unwrap())
1442 .compute_md5()
1443 .with_known_md5_hash(ck.md5_hash.clone())
1444 .precompute_checksums()
1445 .await?;
1446 // Note that the checksums do not match the data. This is intentional,
1447 // we are trying to verify that whatever is provided in with_known*()
1448 // is respected.
1449 let want = ck.clone();
1450 assert_eq!(
1451 upload.request.spec.resource.and_then(|r| r.checksums),
1452 Some(want)
1453 );
1454
1455 Ok(())
1456 }
1457
1458 #[tokio::test]
1459 async fn checksum_known_crc32_then_known_md5() -> Result {
1460 let mut engine = Checksum {
1461 crc32c: Some(Crc32c::default()),
1462 md5_hash: Some(Md5::default()),
1463 };
1464 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1465 let ck = engine.finalize();
1466
1467 let client = test_builder().build().await?;
1468 let upload = client
1469 .write_object("my-bucket", "my-object", QUICK)
1470 .with_known_crc32c(ck.crc32c.unwrap())
1471 .with_known_md5_hash(ck.md5_hash.clone())
1472 .precompute_checksums()
1473 .await?;
1474 // Note that the checksums do not match the data. This is intentional,
1475 // we are trying to verify that whatever is provided in with_known*()
1476 // is respected.
1477 let want = ck.clone();
1478 assert_eq!(
1479 upload.request.spec.resource.and_then(|r| r.checksums),
1480 Some(want)
1481 );
1482
1483 Ok(())
1484 }
1485
1486 #[tokio::test]
1487 async fn precompute_checksums_seek_error() -> Result {
1488 let mut source = MockSeekSource::new();
1489 source
1490 .expect_seek()
1491 .once()
1492 .returning(|_| Err(IoError::new(ErrorKind::Deadlock, "test-only")));
1493
1494 let client = test_builder().build().await?;
1495 let err = client
1496 .write_object("my-bucket", "my-object", source)
1497 .precompute_checksums()
1498 .await
1499 .expect_err("seek() returns an error");
1500 assert!(err.is_serialization(), "{err:?}");
1501 assert!(
1502 err.source()
1503 .and_then(|e| e.downcast_ref::<IoError>())
1504 .is_some(),
1505 "{err:?}"
1506 );
1507
1508 Ok(())
1509 }
1510
1511 #[tokio::test]
1512 async fn precompute_checksums_next_error() -> Result {
1513 let mut source = MockSeekSource::new();
1514 source.expect_seek().returning(|_| Ok(()));
1515 let mut seq = mockall::Sequence::new();
1516 source
1517 .expect_next()
1518 .times(3)
1519 .in_sequence(&mut seq)
1520 .returning(|| Some(Ok(bytes::Bytes::new())));
1521 source
1522 .expect_next()
1523 .once()
1524 .in_sequence(&mut seq)
1525 .returning(|| Some(Err(IoError::new(ErrorKind::BrokenPipe, "test-only"))));
1526
1527 let client = test_builder().build().await?;
1528 let err = client
1529 .write_object("my-bucket", "my-object", source)
1530 .precompute_checksums()
1531 .await
1532 .expect_err("seek() returns an error");
1533 assert!(err.is_serialization(), "{err:?}");
1534 assert!(
1535 err.source()
1536 .and_then(|e| e.downcast_ref::<IoError>())
1537 .is_some(),
1538 "{err:?}"
1539 );
1540
1541 Ok(())
1542 }
1543
1544 #[tokio::test]
1545 async fn debug() -> Result {
1546 let client = test_builder().build().await?;
1547 let upload = client
1548 .write_object("my-bucket", "my-object", "")
1549 .precompute_checksums()
1550 .await;
1551
1552 let fmt = format!("{upload:?}");
1553 ["WriteObject", "inner", "spec", "options", "checksum"]
1554 .into_iter()
1555 .for_each(|text| {
1556 assert!(fmt.contains(text), "expected {text} in {fmt}");
1557 });
1558 Ok(())
1559 }
1560}