google::cloud::StreamRange< T > Class Template Reference

A StreamRange<T> is a range of StatusOr<T> where the end-of-stream is indicated by a non-OK Status. More...

#include <google/cloud/stream_range.h>

Classes
class	IteratorImpl
	An input iterator for a StreamRange<T> – DO NOT USE DIRECTLY. More...

Public Types
using	value_type = StatusOr< T >
using	iterator = IteratorImpl< value_type >
using	difference_type = typename iterator::difference_type
using	reference = typename iterator::reference
using	pointer = typename iterator::pointer
using	const_reference = typename iterator::const_reference
using	const_pointer = typename iterator::const_pointer

Public Member Functions
	StreamRange ()=default
	Default-constructs an empty range. More...
	~StreamRange ()
iterator	begin ()
iterator	end ()
Move-only
	StreamRange (StreamRange const &)=delete
StreamRange &	operator= (StreamRange const &)=delete
	StreamRange (StreamRange &&)=default
StreamRange &	operator= (StreamRange &&)=default

Detailed Description

template<typename T>
class google::cloud::StreamRange< T >

A StreamRange<T> is a range of StatusOr<T> where the end-of-stream is indicated by a non-OK Status.

Callers can iterate the range using its begin() and end() members to access iterators that will work with any normal C++ constructs and algorithms that accept Input Iterators.

Callers should only consume/iterate this range.

Example: Iterating a range of 10 integers

// Some function that returns a StreamRange<int>
StreamRange<int> MakeRangeFromOneTo(int n);
 
StreamRange<int> sr = MakeRangeFromOneTo(10);
for (StatusOr<int> const& x : sr) {
  if (!x) {
    std::cerr << "Fail: " << x.status() << "\n";
  } else {
    std::cout << *x << "\n";
  }
}

Note

To construct a StreamRange<T> for testing (e.g. to mock a Connection::ListFoo call), see google::cloud::mocks::MakeStreamRange.

Definition at line 96 of file stream_range.h.

Member Typedef Documentation

const_pointer

template<typename T >

using google::cloud::StreamRange< T >::const_pointer = typename iterator::const_pointer

Definition at line 156 of file stream_range.h.

const_reference

template<typename T >

using google::cloud::StreamRange< T >::const_reference = typename iterator::const_reference

Definition at line 155 of file stream_range.h.

difference_type

template<typename T >

using google::cloud::StreamRange< T >::difference_type = typename iterator::difference_type

Definition at line 152 of file stream_range.h.

iterator

template<typename T >

using google::cloud::StreamRange< T >::iterator = IteratorImpl<value_type>

Definition at line 151 of file stream_range.h.

pointer

template<typename T >

using google::cloud::StreamRange< T >::pointer = typename iterator::pointer

Definition at line 154 of file stream_range.h.

reference

template<typename T >

using google::cloud::StreamRange< T >::reference = typename iterator::reference

Definition at line 153 of file stream_range.h.

value_type

template<typename T >

using google::cloud::StreamRange< T >::value_type = StatusOr<T>

Definition at line 150 of file stream_range.h.

Constructor & Destructor Documentation

StreamRange() [1/3]

template<typename T >

google::cloud::StreamRange< T >::StreamRange ( )

default

Default-constructs an empty range.

~StreamRange()

template<typename T >

google::cloud::StreamRange< T >::~StreamRange ( )

inline

Definition at line 163 of file stream_range.h.

StreamRange() [2/3]

template<typename T >

google::cloud::StreamRange< T >::StreamRange ( StreamRange< T > const &  )

delete

StreamRange() [3/3]

template<typename T >

google::cloud::StreamRange< T >::StreamRange ( StreamRange< T > &&  )

default

Member Function Documentation

begin()

template<typename T >

iterator google::cloud::StreamRange< T >::begin ( )

inline

Definition at line 178 of file stream_range.h.

end()

template<typename T >

iterator google::cloud::StreamRange< T >::end ( )

inline

Definition at line 179 of file stream_range.h.

operator=() [1/2]

template<typename T >

StreamRange& google::cloud::StreamRange< T >::operator= ( StreamRange< T > &&  )

default

operator=() [2/2]

template<typename T >

StreamRange& google::cloud::StreamRange< T >::operator= ( StreamRange< T > const &  )

delete