Struct: s3.SelectObjectContentEventStream

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

Overview

SelectObjectContentEventStream provides the event stream handling for the SelectObjectContent operation.

For testing and mocking the event stream this type should be initialized via the NewSelectObjectContentEventStream constructor function. Using the functional options to pass in nested mock behavior.

Implemented Interfaces

types.AnalyticsFilter, v4.HTTPPresigner, s3.HTTPPresignerV4, types.MetricsFilter, s3.PresignPost, arn.S3ObjectLambdaARN, types.SelectObjectContentEventStream, s3.SelectObjectContentEventStreamReader

Structure Field Summary

• Reader SelectObjectContentEventStreamReader

  SelectObjectContentEventStreamReader is the EventStream reader for the SelectObjectContentEventStream events.

Method Summary

• func (es *SelectObjectContentEventStream) Close() error

  Close closes the stream.

• func (es *SelectObjectContentEventStream) Err() error

  Err returns any error that occurred while reading or writing EventStream Events from the service API’s response.

• func (es *SelectObjectContentEventStream) Events() <-chan types.SelectObjectContentEventStream

  Events returns a channel to read events from.

Structure Field Details

Reader SelectObjectContentEventStreamReader

SelectObjectContentEventStreamReader is the EventStream reader for the SelectObjectContentEventStream events. This value is automatically set by the SDK when the API call is made Use this member when unit testing your code with the SDK to mock out the EventStream Reader.

Must not be nil.

Method Details

func (es *SelectObjectContentEventStream) Close() error

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

Will close the underlying EventStream writer and reader, and no more events can be sent or received.

// File 'service/s3/api_op_SelectObjectContent.go', line 435

func (es *SelectObjectContentEventStream) Close() error {
	es.closeOnce.Do(es.safeClose)
	return es.Err()
}

func (es *SelectObjectContentEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API’s response. Returns nil if there were no errors.

// File 'service/s3/api_op_SelectObjectContent.go', line 448

func (es *SelectObjectContentEventStream) Err() error {
	if err := es.err.Err(); err != nil {
		return err
	}

	if err := es.Reader.Err(); err != nil {
		return err
	}

	return nil
}

func (es *SelectObjectContentEventStream) Events() <-chan types.SelectObjectContentEventStream

Events returns a channel to read events from.

// File 'service/s3/api_op_SelectObjectContent.go', line 425

func (es *SelectObjectContentEventStream) Events() <-chan types.SelectObjectContentEventStream {
	return es.Reader.Events()
}