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 /// Sets the object custom contexts.
588 ///
589 /// # Example
590 /// ```
591 /// # use google_cloud_storage::client::Storage;
592 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
593 /// # use google_cloud_storage::model::{ObjectContexts, ObjectCustomContextPayload};
594 /// let response = client
595 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
596 /// .set_contexts(
597 /// ObjectContexts::new().set_custom([
598 /// ("example", ObjectCustomContextPayload::new().set_value("true")),
599 /// ])
600 /// )
601 /// .send_buffered()
602 /// .await?;
603 /// println!("response details={response:?}");
604 /// # Ok(()) }
605 /// ```
606 pub fn set_contexts<V>(mut self, v: V) -> Self
607 where
608 V: Into<crate::model::ObjectContexts>,
609 {
610 self.mut_resource().contexts = Some(v.into());
611 self
612 }
613
614 /// Configure the idempotency for this upload.
615 ///
616 /// By default, the client library treats single-shot uploads without
617 /// preconditions, as non-idempotent. If the destination bucket is
618 /// configured with [object versioning] then the operation may succeed
619 /// multiple times with observable side-effects. With object versioning and
620 /// a [lifecycle] policy limiting the number of versions, uploading the same
621 /// data multiple times may result in data loss.
622 ///
623 /// The client library cannot efficiently determine if these conditions
624 /// apply to your upload. If they do, or your application can tolerate
625 /// multiple versions of the same data for other reasons, consider using
626 /// `with_idempotency(true)`.
627 ///
628 /// The client library treats resumable uploads as idempotent, regardless of
629 /// the value in this option. Such uploads can succeed at most once.
630 ///
631 /// # Example
632 /// ```
633 /// # use google_cloud_storage::client::Storage;
634 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
635 /// use std::time::Duration;
636 /// use google_cloud_gax::retry_policy::RetryPolicyExt;
637 /// let response = client
638 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
639 /// .with_idempotency(true)
640 /// .send_buffered()
641 /// .await?;
642 /// println!("response details={response:?}");
643 /// # Ok(()) }
644 /// ```
645 ///
646 /// [lifecycle]: https://cloud.google.com/storage/docs/lifecycle
647 /// [object versioning]: https://cloud.google.com/storage/docs/object-versioning
648 pub fn with_idempotency(mut self, v: bool) -> Self {
649 self.options.idempotency = Some(v);
650 self
651 }
652
653 /// The retry policy used for this request.
654 ///
655 /// # Example
656 /// ```
657 /// # use google_cloud_storage::client::Storage;
658 /// # use google_cloud_storage::retry_policy::RetryableErrors;
659 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
660 /// use std::time::Duration;
661 /// use google_cloud_gax::retry_policy::RetryPolicyExt;
662 /// let response = client
663 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
664 /// .with_retry_policy(
665 /// RetryableErrors
666 /// .with_attempt_limit(5)
667 /// .with_time_limit(Duration::from_secs(90)),
668 /// )
669 /// .send_buffered()
670 /// .await?;
671 /// println!("response details={response:?}");
672 /// # Ok(()) }
673 /// ```
674 pub fn with_retry_policy<V: Into<google_cloud_gax::retry_policy::RetryPolicyArg>>(
675 mut self,
676 v: V,
677 ) -> Self {
678 self.options.retry_policy = v.into().into();
679 self
680 }
681
682 /// The backoff policy used for this request.
683 ///
684 /// # Example
685 /// ```
686 /// # use google_cloud_storage::client::Storage;
687 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
688 /// use std::time::Duration;
689 /// use google_cloud_gax::exponential_backoff::ExponentialBackoff;
690 /// let response = client
691 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
692 /// .with_backoff_policy(ExponentialBackoff::default())
693 /// .send_buffered()
694 /// .await?;
695 /// println!("response details={response:?}");
696 /// # Ok(()) }
697 /// ```
698 pub fn with_backoff_policy<V: Into<google_cloud_gax::backoff_policy::BackoffPolicyArg>>(
699 mut self,
700 v: V,
701 ) -> Self {
702 self.options.backoff_policy = v.into().into();
703 self
704 }
705
706 /// The retry throttler used for this request.
707 ///
708 /// Most of the time you want to use the same throttler for all the requests
709 /// in a client, and even the same throttler for many clients. Rarely it
710 /// may be necessary to use an custom throttler for some subset of the
711 /// requests.
712 ///
713 /// # Example
714 /// ```
715 /// # use google_cloud_storage::client::Storage;
716 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
717 /// let response = client
718 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
719 /// .with_retry_throttler(adhoc_throttler())
720 /// .send_buffered()
721 /// .await?;
722 /// println!("response details={response:?}");
723 /// fn adhoc_throttler() -> google_cloud_gax::retry_throttler::SharedRetryThrottler {
724 /// # panic!();
725 /// }
726 /// # Ok(()) }
727 /// ```
728 pub fn with_retry_throttler<V: Into<google_cloud_gax::retry_throttler::RetryThrottlerArg>>(
729 mut self,
730 v: V,
731 ) -> Self {
732 self.options.retry_throttler = v.into().into();
733 self
734 }
735
736 /// Sets the payload size threshold to switch from single-shot to resumable uploads.
737 ///
738 /// # Example
739 /// ```
740 /// # use google_cloud_storage::client::Storage;
741 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
742 /// let response = client
743 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
744 /// .with_resumable_upload_threshold(0_usize) // Forces a resumable upload.
745 /// .send_buffered()
746 /// .await?;
747 /// println!("response details={response:?}");
748 /// # Ok(()) }
749 /// ```
750 ///
751 /// The client library can perform uploads using [single-shot] or
752 /// [resumable] uploads. For small objects, single-shot uploads offer better
753 /// performance, as they require a single HTTP transfer. For larger objects,
754 /// the additional request latency is not significant, and resumable uploads
755 /// offer better recovery on errors.
756 ///
757 /// The library automatically selects resumable uploads when the payload is
758 /// equal to or larger than this option. For smaller uploads the client
759 /// library uses single-shot uploads.
760 ///
761 /// The exact threshold depends on where the application is deployed and
762 /// destination bucket location with respect to where the application is
763 /// running. The library defaults should work well in most cases, but some
764 /// applications may benefit from fine-tuning.
765 ///
766 /// [single-shot]: https://cloud.google.com/storage/docs/uploading-objects
767 /// [resumable]: https://cloud.google.com/storage/docs/resumable-uploads
768 pub fn with_resumable_upload_threshold<V: Into<usize>>(mut self, v: V) -> Self {
769 self.options.set_resumable_upload_threshold(v.into());
770 self
771 }
772
773 /// Changes the buffer size for some resumable uploads.
774 ///
775 /// # Example
776 /// ```
777 /// # use google_cloud_storage::client::Storage;
778 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
779 /// let response = client
780 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
781 /// .with_resumable_upload_buffer_size(32 * 1024 * 1024_usize)
782 /// .send_buffered()
783 /// .await?;
784 /// println!("response details={response:?}");
785 /// # Ok(()) }
786 /// ```
787 ///
788 /// When performing [resumable uploads] from sources without [Seek] the
789 /// client library needs to buffer data in memory until it is persisted by
790 /// the service. Otherwise the data would be lost if the upload fails.
791 /// Applications may want to tune this buffer size:
792 ///
793 /// - Use smaller buffer sizes to support more concurrent uploads in the
794 /// same application.
795 /// - Use larger buffer sizes for better throughput. Sending many small
796 /// buffers stalls the upload until the client receives a successful
797 /// response from the service.
798 ///
799 /// Keep in mind that there are diminishing returns on using larger buffers.
800 ///
801 /// [resumable uploads]: https://cloud.google.com/storage/docs/resumable-uploads
802 /// [Seek]: crate::streaming_source::Seek
803 pub fn with_resumable_upload_buffer_size<V: Into<usize>>(mut self, v: V) -> Self {
804 self.options.set_resumable_upload_buffer_size(v.into());
805 self
806 }
807
808 fn mut_resource(&mut self) -> &mut crate::model::Object {
809 self.request
810 .spec
811 .resource
812 .as_mut()
813 .expect("resource field initialized in `new()`")
814 }
815
816 fn set_crc32c<V: Into<u32>>(mut self, v: V) -> Self {
817 let checksum = self.mut_resource().checksums.get_or_insert_default();
818 checksum.crc32c = Some(v.into());
819 self
820 }
821
822 pub fn set_md5_hash<I, V>(mut self, i: I) -> Self
823 where
824 I: IntoIterator<Item = V>,
825 V: Into<u8>,
826 {
827 let checksum = self.mut_resource().checksums.get_or_insert_default();
828 checksum.md5_hash = i.into_iter().map(|v| v.into()).collect();
829 self
830 }
831
832 /// Provide a precomputed value for the CRC32C checksum.
833 ///
834 /// # Example
835 /// ```
836 /// # use google_cloud_storage::client::Storage;
837 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
838 /// use crc32c::crc32c;
839 /// let response = client
840 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
841 /// .with_known_crc32c(crc32c(b"hello world"))
842 /// .send_buffered()
843 /// .await?;
844 /// println!("response details={response:?}");
845 /// # Ok(()) }
846 /// ```
847 ///
848 /// In some applications, the payload's CRC32C checksum is already known.
849 /// For example, the application may be reading the data from another blob
850 /// storage system.
851 ///
852 /// In such cases, it is safer to pass the known CRC32C of the payload to
853 /// [Cloud Storage], and more efficient to skip the computation in the
854 /// client library.
855 ///
856 /// Note that once you provide a CRC32C value to this builder you cannot
857 /// use [compute_md5()] to also have the library compute the checksums.
858 ///
859 /// [compute_md5()]: WriteObject::compute_md5
860 pub fn with_known_crc32c<V: Into<u32>>(self, v: V) -> Self {
861 let mut this = self;
862 this.options.checksum.crc32c = None;
863 this.set_crc32c(v)
864 }
865
866 /// Provide a precomputed value for the MD5 hash.
867 ///
868 /// # Example
869 /// ```
870 /// # use google_cloud_storage::client::Storage;
871 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
872 /// use md5::compute;
873 /// let hash = md5::compute(b"hello world");
874 /// let response = client
875 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
876 /// .with_known_md5_hash(bytes::Bytes::from_owner(hash.0))
877 /// .send_buffered()
878 /// .await?;
879 /// println!("response details={response:?}");
880 /// # Ok(()) }
881 /// ```
882 ///
883 /// In some applications, the payload's MD5 hash is already known. For
884 /// example, the application may be reading the data from another blob
885 /// storage system.
886 ///
887 /// In such cases, it is safer to pass the known MD5 of the payload to
888 /// [Cloud Storage], and more efficient to skip the computation in the
889 /// client library.
890 ///
891 /// Note that once you provide a MD5 value to this builder you cannot
892 /// use [compute_md5()] to also have the library compute the checksums.
893 ///
894 /// [compute_md5()]: WriteObject::compute_md5
895 pub fn with_known_md5_hash<I, V>(self, i: I) -> Self
896 where
897 I: IntoIterator<Item = V>,
898 V: Into<u8>,
899 {
900 let mut this = self;
901 this.options.checksum.md5_hash = None;
902 this.set_md5_hash(i)
903 }
904
905 /// Enables computation of MD5 hashes.
906 ///
907 /// # Example
908 /// ```
909 /// # use google_cloud_storage::client::Storage;
910 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
911 /// let payload = tokio::fs::File::open("my-data").await?;
912 /// let response = client
913 /// .write_object("projects/_/buckets/my-bucket", "my-object", payload)
914 /// .compute_md5()
915 /// .send_buffered()
916 /// .await?;
917 /// println!("response details={response:?}");
918 /// # Ok(()) }
919 /// ```
920 ///
921 /// See [precompute_checksums][WriteObject::precompute_checksums] for more
922 /// details on how checksums are used by the client library and their
923 /// limitations.
924 pub fn compute_md5(self) -> Self {
925 let mut this = self;
926 this.options.checksum.md5_hash = Some(Md5::default());
927 this
928 }
929
930 pub(crate) fn new<B, O, P>(
931 stub: std::sync::Arc<S>,
932 bucket: B,
933 object: O,
934 payload: P,
935 options: RequestOptions,
936 ) -> Self
937 where
938 B: Into<String>,
939 O: Into<String>,
940 P: Into<Payload<T>>,
941 {
942 let resource = crate::model::Object::new()
943 .set_bucket(bucket)
944 .set_name(object);
945 WriteObject {
946 stub,
947 request: crate::model_ext::WriteObjectRequest {
948 spec: crate::model::WriteObjectSpec::new().set_resource(resource),
949 params: None,
950 },
951 payload: payload.into(),
952 options,
953 }
954 }
955}
956
957impl<T, S> WriteObject<T, S>
958where
959 T: StreamingSource + Seek + Send + Sync + 'static,
960 <T as StreamingSource>::Error: std::error::Error + Send + Sync + 'static,
961 <T as Seek>::Error: std::error::Error + Send + Sync + 'static,
962 S: crate::storage::stub::Storage + 'static,
963{
964 /// A simple upload from a buffer.
965 ///
966 /// # Example
967 /// ```
968 /// # use google_cloud_storage::client::Storage;
969 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
970 /// let response = client
971 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
972 /// .send_unbuffered()
973 /// .await?;
974 /// println!("response details={response:?}");
975 /// # Ok(()) }
976 /// ```
977 pub async fn send_unbuffered(self) -> Result<Object> {
978 self.stub
979 .write_object_unbuffered(self.payload, self.request, self.options)
980 .await
981 }
982
983 /// Precompute the payload checksums before uploading the data.
984 ///
985 /// If the checksums are known when the upload starts, the client library
986 /// can include the checksums with the upload request, and the service can
987 /// reject the upload if the payload and the checksums do not match.
988 ///
989 /// # Example
990 /// ```
991 /// # use google_cloud_storage::client::Storage;
992 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
993 /// let payload = tokio::fs::File::open("my-data").await?;
994 /// let response = client
995 /// .write_object("projects/_/buckets/my-bucket", "my-object", payload)
996 /// .precompute_checksums()
997 /// .await?
998 /// .send_unbuffered()
999 /// .await?;
1000 /// println!("response details={response:?}");
1001 /// # Ok(()) }
1002 /// ```
1003 ///
1004 /// Precomputing the checksums can be expensive if the data source is slow
1005 /// to read. Therefore, the client library does not precompute the checksums
1006 /// by default. The client library compares the checksums computed by the
1007 /// service against its own checksums. If they do not match, the client
1008 /// library returns an error. However, the service has already created the
1009 /// object with the (likely incorrect) data.
1010 ///
1011 /// The client library currently uses the [JSON API], it is not possible to
1012 /// send the checksums at the end of the upload with this API.
1013 ///
1014 /// [JSON API]: https://cloud.google.com/storage/docs/json_api
1015 pub async fn precompute_checksums(mut self) -> Result<Self> {
1016 let mut offset = 0_u64;
1017 self.payload.seek(offset).await.map_err(Error::ser)?;
1018 while let Some(n) = self.payload.next().await.transpose().map_err(Error::ser)? {
1019 self.options.checksum.update(offset, &n);
1020 offset += n.len() as u64;
1021 }
1022 self.payload.seek(0_u64).await.map_err(Error::ser)?;
1023 let computed = self.options.checksum.finalize();
1024 let current = self.mut_resource().checksums.get_or_insert_default();
1025 checksum_update(current, computed);
1026 self.options.checksum = Checksum {
1027 crc32c: None,
1028 md5_hash: None,
1029 };
1030 Ok(self)
1031 }
1032}
1033
1034impl<T, S> WriteObject<T, S>
1035where
1036 T: StreamingSource + Send + Sync + 'static,
1037 T::Error: std::error::Error + Send + Sync + 'static,
1038 S: crate::storage::stub::Storage + 'static,
1039{
1040 /// Upload an object from a streaming source without rewinds.
1041 ///
1042 /// If the data source does **not** implement [Seek] the client library must
1043 /// buffer data sent to the service until the service confirms it has
1044 /// persisted the data. This requires more memory in the client, and when
1045 /// the buffer grows too large, may require stalling the writer until the
1046 /// service can persist the data.
1047 ///
1048 /// Use this function for data sources where it is expensive or impossible
1049 /// to restart the data source. This function is also useful when it is hard
1050 /// or impossible to predict the number of bytes emitted by a stream, even
1051 /// if restarting the stream is not too expensive.
1052 ///
1053 /// # Example
1054 /// ```
1055 /// # use google_cloud_storage::client::Storage;
1056 /// # async fn sample(client: &Storage) -> anyhow::Result<()> {
1057 /// let response = client
1058 /// .write_object("projects/_/buckets/my-bucket", "my-object", "hello world")
1059 /// .send_buffered()
1060 /// .await?;
1061 /// println!("response details={response:?}");
1062 /// # Ok(()) }
1063 /// ```
1064 pub async fn send_buffered(self) -> crate::Result<Object> {
1065 self.stub
1066 .write_object_buffered(self.payload, self.request, self.options)
1067 .await
1068 }
1069}
1070
1071// We need `Debug` to use `expect_err()` in `Result<WriteObject, ...>`.
1072impl<T, S> std::fmt::Debug for WriteObject<T, S>
1073where
1074 S: crate::storage::stub::Storage + 'static,
1075{
1076 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1077 f.debug_struct("WriteObject")
1078 .field("stub", &self.stub)
1079 .field("request", &self.request)
1080 // skip payload, as it is not `Debug`
1081 .field("options", &self.options)
1082 .finish()
1083 }
1084}
1085
1086#[cfg(test)]
1087mod tests {
1088 use super::client::tests::{test_builder, test_inner_client};
1089 use super::*;
1090 use crate::client::Storage;
1091 use crate::model::{
1092 CommonObjectRequestParams, ObjectChecksums, ObjectContexts, ObjectCustomContextPayload,
1093 WriteObjectSpec,
1094 };
1095 use crate::storage::checksum::details::{Crc32c, Md5};
1096 use crate::streaming_source::tests::MockSeekSource;
1097 use google_cloud_auth::credentials::anonymous::Builder as Anonymous;
1098 use std::error::Error as _;
1099 use std::io::{Error as IoError, ErrorKind};
1100
1101 type Result = anyhow::Result<()>;
1102
1103 // Verify `write_object()` can be used with a source that implements
1104 // `StreamingSource` **and** `Seek`
1105 #[tokio::test]
1106 async fn test_upload_streaming_source_and_seek() -> Result {
1107 struct Source;
1108 impl crate::streaming_source::StreamingSource for Source {
1109 type Error = std::io::Error;
1110 async fn next(&mut self) -> Option<std::result::Result<bytes::Bytes, Self::Error>> {
1111 None
1112 }
1113 }
1114 impl crate::streaming_source::Seek for Source {
1115 type Error = std::io::Error;
1116 async fn seek(&mut self, _offset: u64) -> std::result::Result<(), Self::Error> {
1117 Ok(())
1118 }
1119 }
1120
1121 let client = Storage::builder()
1122 .with_credentials(Anonymous::new().build())
1123 .build()
1124 .await?;
1125 let _ = client.write_object("projects/_/buckets/test-bucket", "test-object", Source);
1126 Ok(())
1127 }
1128
1129 // Verify `write_object()` can be used with a source that **only**
1130 // implements `StreamingSource`.
1131 #[tokio::test]
1132 async fn test_upload_only_streaming_source() -> Result {
1133 struct Source;
1134 impl crate::streaming_source::StreamingSource for Source {
1135 type Error = std::io::Error;
1136 async fn next(&mut self) -> Option<std::result::Result<bytes::Bytes, Self::Error>> {
1137 None
1138 }
1139 }
1140
1141 let client = Storage::builder()
1142 .with_credentials(Anonymous::new().build())
1143 .build()
1144 .await?;
1145 let _ = client.write_object("projects/_/buckets/test-bucket", "test-object", Source);
1146 Ok(())
1147 }
1148
1149 // Verify `write_object()` meets normal Send, Sync, requirements.
1150 #[tokio::test]
1151 async fn test_upload_is_send_and_static() -> Result {
1152 let client = Storage::builder()
1153 .with_credentials(Anonymous::new().build())
1154 .build()
1155 .await?;
1156
1157 fn need_send<T: Send>(_val: &T) {}
1158 fn need_sync<T: Sync>(_val: &T) {}
1159 fn need_static<T: 'static>(_val: &T) {}
1160
1161 let upload = client.write_object("projects/_/buckets/test-bucket", "test-object", "");
1162 need_send(&upload);
1163 need_sync(&upload);
1164 need_static(&upload);
1165
1166 let upload = client
1167 .write_object("projects/_/buckets/test-bucket", "test-object", "")
1168 .send_unbuffered();
1169 need_send(&upload);
1170 need_static(&upload);
1171
1172 let upload = client
1173 .write_object("projects/_/buckets/test-bucket", "test-object", "")
1174 .send_buffered();
1175 need_send(&upload);
1176 need_static(&upload);
1177
1178 Ok(())
1179 }
1180
1181 #[tokio::test]
1182 async fn write_object_metadata() -> Result {
1183 use crate::model::ObjectAccessControl;
1184 let inner = test_inner_client(test_builder()).await;
1185 let options = inner.options.clone();
1186 let stub = crate::storage::transport::Storage::new(inner);
1187 let key = KeyAes256::new(&[0x42; 32]).expect("hard-coded key is not an error");
1188 let mut builder =
1189 WriteObject::new(stub, "projects/_/buckets/bucket", "object", "", options)
1190 .set_if_generation_match(10)
1191 .set_if_generation_not_match(20)
1192 .set_if_metageneration_match(30)
1193 .set_if_metageneration_not_match(40)
1194 .set_predefined_acl("private")
1195 .set_acl([ObjectAccessControl::new()
1196 .set_entity("allAuthenticatedUsers")
1197 .set_role("READER")])
1198 .set_cache_control("public; max-age=7200")
1199 .set_content_disposition("inline")
1200 .set_content_encoding("gzip")
1201 .set_content_language("en")
1202 .set_content_type("text/plain")
1203 .set_contexts(ObjectContexts::new().set_custom([(
1204 "context-key",
1205 ObjectCustomContextPayload::new().set_value("context-value"),
1206 )]))
1207 .set_custom_time(wkt::Timestamp::try_from("2025-07-07T18:11:00Z")?)
1208 .set_event_based_hold(true)
1209 .set_key(key.clone())
1210 .set_metadata([("k0", "v0"), ("k1", "v1")])
1211 .set_retention(
1212 crate::model::object::Retention::new()
1213 .set_mode(crate::model::object::retention::Mode::Locked)
1214 .set_retain_until_time(wkt::Timestamp::try_from("2035-07-07T18:14:00Z")?),
1215 )
1216 .set_storage_class("ARCHIVE")
1217 .set_temporary_hold(true)
1218 .set_kms_key("test-key")
1219 .with_known_crc32c(crc32c::crc32c(b""))
1220 .with_known_md5_hash(md5::compute(b"").0);
1221
1222 let resource = builder.request.spec.resource.take().unwrap();
1223 let builder = builder;
1224 assert_eq!(
1225 &builder.request.spec,
1226 &WriteObjectSpec::new()
1227 .set_if_generation_match(10)
1228 .set_if_generation_not_match(20)
1229 .set_if_metageneration_match(30)
1230 .set_if_metageneration_not_match(40)
1231 .set_predefined_acl("private")
1232 );
1233
1234 assert_eq!(
1235 &builder.request.params,
1236 &Some(CommonObjectRequestParams::from(key))
1237 );
1238
1239 assert_eq!(
1240 resource,
1241 Object::new()
1242 .set_name("object")
1243 .set_bucket("projects/_/buckets/bucket")
1244 .set_acl([ObjectAccessControl::new()
1245 .set_entity("allAuthenticatedUsers")
1246 .set_role("READER")])
1247 .set_cache_control("public; max-age=7200")
1248 .set_content_disposition("inline")
1249 .set_content_encoding("gzip")
1250 .set_content_language("en")
1251 .set_content_type("text/plain")
1252 .set_contexts(ObjectContexts::new().set_custom([(
1253 "context-key",
1254 ObjectCustomContextPayload::new().set_value("context-value"),
1255 )]))
1256 .set_checksums(
1257 crate::model::ObjectChecksums::new()
1258 .set_crc32c(crc32c::crc32c(b""))
1259 .set_md5_hash(bytes::Bytes::from_iter(md5::compute(b"").0))
1260 )
1261 .set_custom_time(wkt::Timestamp::try_from("2025-07-07T18:11:00Z")?)
1262 .set_event_based_hold(true)
1263 .set_metadata([("k0", "v0"), ("k1", "v1")])
1264 .set_retention(
1265 crate::model::object::Retention::new()
1266 .set_mode("LOCKED")
1267 .set_retain_until_time(wkt::Timestamp::try_from("2035-07-07T18:14:00Z")?)
1268 )
1269 .set_storage_class("ARCHIVE")
1270 .set_temporary_hold(true)
1271 .set_kms_key("test-key")
1272 );
1273
1274 Ok(())
1275 }
1276
1277 #[tokio::test]
1278 async fn upload_object_options() {
1279 let inner = test_inner_client(
1280 test_builder()
1281 .with_resumable_upload_threshold(123_usize)
1282 .with_resumable_upload_buffer_size(234_usize),
1283 )
1284 .await;
1285 let options = inner.options.clone();
1286 let stub = crate::storage::transport::Storage::new(inner);
1287 let request = WriteObject::new(
1288 stub.clone(),
1289 "projects/_/buckets/bucket",
1290 "object",
1291 "",
1292 options.clone(),
1293 );
1294 assert_eq!(request.options.resumable_upload_threshold(), 123);
1295 assert_eq!(request.options.resumable_upload_buffer_size(), 234);
1296
1297 let request = WriteObject::new(stub, "projects/_/buckets/bucket", "object", "", options)
1298 .with_resumable_upload_threshold(345_usize)
1299 .with_resumable_upload_buffer_size(456_usize);
1300 assert_eq!(request.options.resumable_upload_threshold(), 345);
1301 assert_eq!(request.options.resumable_upload_buffer_size(), 456);
1302 }
1303
1304 const QUICK: &str = "the quick brown fox jumps over the lazy dog";
1305 const VEXING: &str = "how vexingly quick daft zebras jump";
1306
1307 fn quick_checksum(mut engine: Checksum) -> ObjectChecksums {
1308 engine.update(0, &bytes::Bytes::from_static(QUICK.as_bytes()));
1309 engine.finalize()
1310 }
1311
1312 async fn collect<S: StreamingSource>(mut stream: S) -> anyhow::Result<Vec<u8>> {
1313 let mut collected = Vec::new();
1314 while let Some(b) = stream.next().await.transpose()? {
1315 collected.extend_from_slice(&b);
1316 }
1317 Ok(collected)
1318 }
1319
1320 #[tokio::test]
1321 async fn checksum_default() -> Result {
1322 let client = test_builder().build().await?;
1323 let upload = client
1324 .write_object("my-bucket", "my-object", QUICK)
1325 .precompute_checksums()
1326 .await?;
1327 let want = quick_checksum(Checksum {
1328 crc32c: Some(Crc32c::default()),
1329 md5_hash: None,
1330 });
1331 assert_eq!(
1332 upload.request.spec.resource.and_then(|r| r.checksums),
1333 Some(want)
1334 );
1335 let collected = collect(upload.payload).await?;
1336 assert_eq!(collected, QUICK.as_bytes());
1337 Ok(())
1338 }
1339
1340 #[tokio::test]
1341 async fn checksum_md5_and_crc32c() -> Result {
1342 let client = test_builder().build().await?;
1343 let upload = client
1344 .write_object("my-bucket", "my-object", QUICK)
1345 .compute_md5()
1346 .precompute_checksums()
1347 .await?;
1348 let want = quick_checksum(Checksum {
1349 crc32c: Some(Crc32c::default()),
1350 md5_hash: Some(Md5::default()),
1351 });
1352 assert_eq!(
1353 upload.request.spec.resource.and_then(|r| r.checksums),
1354 Some(want)
1355 );
1356 Ok(())
1357 }
1358
1359 #[tokio::test]
1360 async fn checksum_precomputed() -> Result {
1361 let mut engine = Checksum {
1362 crc32c: Some(Crc32c::default()),
1363 md5_hash: Some(Md5::default()),
1364 };
1365 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1366 let ck = engine.finalize();
1367
1368 let client = test_builder().build().await?;
1369 let upload = client
1370 .write_object("my-bucket", "my-object", QUICK)
1371 .with_known_crc32c(ck.crc32c.unwrap())
1372 .with_known_md5_hash(ck.md5_hash.clone())
1373 .precompute_checksums()
1374 .await?;
1375 // Note that the checksums do not match the data. This is intentional,
1376 // we are trying to verify that whatever is provided in with_crc32c()
1377 // and with_md5() is respected.
1378 assert_eq!(
1379 upload.request.spec.resource.and_then(|r| r.checksums),
1380 Some(ck)
1381 );
1382
1383 Ok(())
1384 }
1385
1386 #[tokio::test]
1387 async fn checksum_crc32c_known_md5_computed() -> Result {
1388 let mut engine = Checksum {
1389 crc32c: Some(Crc32c::default()),
1390 md5_hash: Some(Md5::default()),
1391 };
1392 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1393 let ck = engine.finalize();
1394
1395 let client = test_builder().build().await?;
1396 let upload = client
1397 .write_object("my-bucket", "my-object", QUICK)
1398 .compute_md5()
1399 .with_known_crc32c(ck.crc32c.unwrap())
1400 .precompute_checksums()
1401 .await?;
1402 // Note that the checksums do not match the data. This is intentional,
1403 // we are trying to verify that whatever is provided in with_known*()
1404 // is respected.
1405 let want = quick_checksum(Checksum {
1406 crc32c: None,
1407 md5_hash: Some(Md5::default()),
1408 })
1409 .set_crc32c(ck.crc32c.unwrap());
1410 assert_eq!(
1411 upload.request.spec.resource.and_then(|r| r.checksums),
1412 Some(want)
1413 );
1414
1415 Ok(())
1416 }
1417
1418 #[tokio::test]
1419 async fn checksum_mixed_then_precomputed() -> Result {
1420 let mut engine = Checksum {
1421 crc32c: Some(Crc32c::default()),
1422 md5_hash: Some(Md5::default()),
1423 };
1424 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1425 let ck = engine.finalize();
1426
1427 let client = test_builder().build().await?;
1428 let upload = client
1429 .write_object("my-bucket", "my-object", QUICK)
1430 .with_known_md5_hash(ck.md5_hash.clone())
1431 .with_known_crc32c(ck.crc32c.unwrap())
1432 .precompute_checksums()
1433 .await?;
1434 // Note that the checksums do not match the data. This is intentional,
1435 // we are trying to verify that whatever is provided in with_known*()
1436 // is respected.
1437 let want = ck.clone();
1438 assert_eq!(
1439 upload.request.spec.resource.and_then(|r| r.checksums),
1440 Some(want)
1441 );
1442
1443 Ok(())
1444 }
1445
1446 #[tokio::test]
1447 async fn checksum_full_computed_then_md5_precomputed() -> Result {
1448 let mut engine = Checksum {
1449 crc32c: Some(Crc32c::default()),
1450 md5_hash: Some(Md5::default()),
1451 };
1452 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1453 let ck = engine.finalize();
1454
1455 let client = test_builder().build().await?;
1456 let upload = client
1457 .write_object("my-bucket", "my-object", QUICK)
1458 .compute_md5()
1459 .with_known_md5_hash(ck.md5_hash.clone())
1460 .precompute_checksums()
1461 .await?;
1462 // Note that the checksums do not match the data. This is intentional,
1463 // we are trying to verify that whatever is provided in with_known*()
1464 // is respected.
1465 let want = quick_checksum(Checksum {
1466 crc32c: Some(Crc32c::default()),
1467 md5_hash: None,
1468 })
1469 .set_md5_hash(ck.md5_hash.clone());
1470 assert_eq!(
1471 upload.request.spec.resource.and_then(|r| r.checksums),
1472 Some(want)
1473 );
1474
1475 Ok(())
1476 }
1477
1478 #[tokio::test]
1479 async fn checksum_known_crc32_then_computed_md5() -> Result {
1480 let mut engine = Checksum {
1481 crc32c: Some(Crc32c::default()),
1482 md5_hash: Some(Md5::default()),
1483 };
1484 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1485 let ck = engine.finalize();
1486
1487 let client = test_builder().build().await?;
1488 let upload = client
1489 .write_object("my-bucket", "my-object", QUICK)
1490 .with_known_crc32c(ck.crc32c.unwrap())
1491 .compute_md5()
1492 .with_known_md5_hash(ck.md5_hash.clone())
1493 .precompute_checksums()
1494 .await?;
1495 // Note that the checksums do not match the data. This is intentional,
1496 // we are trying to verify that whatever is provided in with_known*()
1497 // is respected.
1498 let want = ck.clone();
1499 assert_eq!(
1500 upload.request.spec.resource.and_then(|r| r.checksums),
1501 Some(want)
1502 );
1503
1504 Ok(())
1505 }
1506
1507 #[tokio::test]
1508 async fn checksum_known_crc32_then_known_md5() -> Result {
1509 let mut engine = Checksum {
1510 crc32c: Some(Crc32c::default()),
1511 md5_hash: Some(Md5::default()),
1512 };
1513 engine.update(0, &bytes::Bytes::from_static(VEXING.as_bytes()));
1514 let ck = engine.finalize();
1515
1516 let client = test_builder().build().await?;
1517 let upload = client
1518 .write_object("my-bucket", "my-object", QUICK)
1519 .with_known_crc32c(ck.crc32c.unwrap())
1520 .with_known_md5_hash(ck.md5_hash.clone())
1521 .precompute_checksums()
1522 .await?;
1523 // Note that the checksums do not match the data. This is intentional,
1524 // we are trying to verify that whatever is provided in with_known*()
1525 // is respected.
1526 let want = ck.clone();
1527 assert_eq!(
1528 upload.request.spec.resource.and_then(|r| r.checksums),
1529 Some(want)
1530 );
1531
1532 Ok(())
1533 }
1534
1535 #[tokio::test]
1536 async fn precompute_checksums_seek_error() -> Result {
1537 let mut source = MockSeekSource::new();
1538 source
1539 .expect_seek()
1540 .once()
1541 .returning(|_| Err(IoError::new(ErrorKind::Deadlock, "test-only")));
1542
1543 let client = test_builder().build().await?;
1544 let err = client
1545 .write_object("my-bucket", "my-object", source)
1546 .precompute_checksums()
1547 .await
1548 .expect_err("seek() returns an error");
1549 assert!(err.is_serialization(), "{err:?}");
1550 assert!(
1551 err.source()
1552 .and_then(|e| e.downcast_ref::<IoError>())
1553 .is_some(),
1554 "{err:?}"
1555 );
1556
1557 Ok(())
1558 }
1559
1560 #[tokio::test]
1561 async fn precompute_checksums_next_error() -> Result {
1562 let mut source = MockSeekSource::new();
1563 source.expect_seek().returning(|_| Ok(()));
1564 let mut seq = mockall::Sequence::new();
1565 source
1566 .expect_next()
1567 .times(3)
1568 .in_sequence(&mut seq)
1569 .returning(|| Some(Ok(bytes::Bytes::new())));
1570 source
1571 .expect_next()
1572 .once()
1573 .in_sequence(&mut seq)
1574 .returning(|| Some(Err(IoError::new(ErrorKind::BrokenPipe, "test-only"))));
1575
1576 let client = test_builder().build().await?;
1577 let err = client
1578 .write_object("my-bucket", "my-object", source)
1579 .precompute_checksums()
1580 .await
1581 .expect_err("seek() returns an error");
1582 assert!(err.is_serialization(), "{err:?}");
1583 assert!(
1584 err.source()
1585 .and_then(|e| e.downcast_ref::<IoError>())
1586 .is_some(),
1587 "{err:?}"
1588 );
1589
1590 Ok(())
1591 }
1592
1593 #[tokio::test]
1594 async fn debug() -> Result {
1595 let client = test_builder().build().await?;
1596 let upload = client
1597 .write_object("my-bucket", "my-object", "")
1598 .precompute_checksums()
1599 .await;
1600
1601 let fmt = format!("{upload:?}");
1602 ["WriteObject", "inner", "spec", "options", "checksum"]
1603 .into_iter()
1604 .for_each(|text| {
1605 assert!(fmt.contains(text), "expected {text} in {fmt}");
1606 });
1607 Ok(())
1608 }
1609}