Struct: s3manager.DownloadObjectsIterator

import "../ibm-cos-sdk-go/service/s3/s3manager"

Overview

DownloadObjectsIterator implements the BatchDownloadIterator interface and allows for batched download of objects.

Implemented Interfaces

s3manager.BatchDownloadIterator, s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• Objects []BatchDownloadObject

Method Summary

• func (batcher *DownloadObjectsIterator) DownloadObject() BatchDownloadObject

  DownloadObject will return the BatchDownloadObject at the current batched index.

• func (batcher *DownloadObjectsIterator) Err() error

  Err will return an error.

• func (batcher *DownloadObjectsIterator) Next() bool

  Next will increment the default iterator's index and ensure that there is another object to iterator to.

Structure Field Details

Objects []BatchDownloadObject

Method Details

func (batcher *DownloadObjectsIterator) DownloadObject() BatchDownloadObject

DownloadObject will return the BatchDownloadObject at the current batched index.

// File 'service/s3/s3manager/batch.go', line 475

func (batcher *DownloadObjectsIterator) DownloadObject() BatchDownloadObject {
	object := batcher.Objects[batcher.index]
	return object
}

func (batcher *DownloadObjectsIterator) Err() error

Err will return an error. Since this is just used to satisfy the BatchDeleteIterator interface this will only return nil.

// File 'service/s3/s3manager/batch.go', line 482

func (batcher *DownloadObjectsIterator) Err() error {
	return nil
}

func (batcher *DownloadObjectsIterator) Next() bool

Next will increment the default iterator's index and ensure that there is another object to iterator to.

// File 'service/s3/s3manager/batch.go', line 465

func (batcher *DownloadObjectsIterator) Next() bool {
	if batcher.inc {
		batcher.index++
	} else {
		batcher.inc = true
	}
	return batcher.index < len(batcher.Objects)
}