Method listObjectsV2

api-list.go:120–199

Bucket List Operations.

(ctx context.Context, bucketName string, opts ListObjectsOptions)

// Bucket List Operations.
func (c *Client) listObjectsV2(ctx context.Context, bucketName string, opts ListObjectsOptions) iter.Seq[ObjectInfo] {
	// Default listing is delimited at "/"
	delimiter := "/"
	if opts.Recursive {
		// If recursive we do not delimit.
		delimiter = ""
	}

	// Return object owner information by default
	fetchOwner := true

	return func(yield func(ObjectInfo) bool) {
		if contextCanceled(ctx) {
			return
		}

		// Validate bucket name.
		if err := s3utils.CheckValidBucketName(bucketName); err != nil {
			yield(ObjectInfo{Err: err})
			return
		}

		// Validate incoming object prefix.
		if err := s3utils.CheckValidObjectNamePrefix(opts.Prefix); err != nil {
			yield(ObjectInfo{Err: err})
			return
		}

		// Save continuationToken for next request.
		var continuationToken string
		for {
			if contextCanceled(ctx) {
				return
			}

			// Get list of objects a maximum of 1000 per request.
			result, err := c.listObjectsV2Query(ctx, bucketName, opts.Prefix, continuationToken,
				fetchOwner, opts.WithMetadata, delimiter, opts.StartAfter, opts.MaxKeys, opts.headers)
			if err != nil {
				yield(ObjectInfo{Err: err})
				return
			}

			// If contents are available loop through and send over channel.
			for _, object := range result.Contents {
				object.ETag = trimEtag(object.ETag)
				if !yield(object) {
					return
				}
			}

			// Send all common prefixes if any.
			// NOTE: prefixes are only present if the request is delimited.
			for _, obj := range result.CommonPrefixes {
				if !yield(ObjectInfo{Key: obj.Prefix}) {
					return
				}
			}