Skip to content

Commit 4c3010b

Browse files
authored
service/s3/s3manager: Add doc for sequential download (#201)
Adds documentation for downloading object sequentially with the S3 download manager.
1 parent d819711 commit 4c3010b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

service/s3/s3manager/download.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ type Downloader struct {
3838
// The number of goroutines to spin up in parallel when sending parts.
3939
// If this is set to zero, the DefaultDownloadConcurrency value will be used.
4040
//
41+
// Concurrency of 1 will download the parts sequentially.
42+
//
4143
// Concurrency is ignored if the Range input parameter is provided.
4244
Concurrency int
4345

@@ -148,6 +150,9 @@ func NewDownloaderWithClient(svc s3iface.S3API, options ...func(*Downloader)) *D
148150
// The w io.WriterAt can be satisfied by an os.File to do multipart concurrent
149151
// downloads, or in memory []byte wrapper using aws.WriteAtBuffer.
150152
//
153+
// Specifying a Downloader.Concurrency of 1 will cause the Downloader to
154+
// download the parts from S3 sequentially.
155+
//
151156
// If the GetObjectInput's Range value is provided that will cause the downloader
152157
// to perform a single GetObjectInput request for that object's range. This will
153158
// caused the part size, and concurrency configurations to be ignored.
@@ -173,6 +178,9 @@ func (d Downloader) Download(w io.WriterAt, input *s3.GetObjectInput, options ..
173178
// The w io.WriterAt can be satisfied by an os.File to do multipart concurrent
174179
// downloads, or in memory []byte wrapper using aws.WriteAtBuffer.
175180
//
181+
// Specifying a Downloader.Concurrency of 1 will cause the Downloader to
182+
// download the parts from S3 sequentially.
183+
//
176184
// It is safe to call this method concurrently across goroutines.
177185
//
178186
// If the GetObjectInput's Range value is provided that will cause the downloader

0 commit comments

Comments
 (0)