homeassistant.components.stream.worker.PeekIterator Class Reference

Inheritance diagram for homeassistant.components.stream.worker.PeekIterator:

Collaboration diagram for homeassistant.components.stream.worker.PeekIterator:

Public Member Functions
None	__init__ (self, Iterator[av.Packet] iterator)
Self	__iter__ (self)
av.Packet	__next__ (self)
Generator[av.Packet]	peek (self)

Private Member Functions
av.Packet	_pop_buffer (self)

Private Attributes
	_iterator
	_next

Detailed Description

An Iterator that may allow multiple passes.

This may be consumed like a normal Iterator, however also supports a
peek() method that buffers consumed items from the iterator.

Definition at line 402 of file worker.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.stream.worker.PeekIterator.__init__	(		self,
		Iterator[av.Packet]	iterator
	)

Initialize PeekIterator.

Definition at line 409 of file worker.py.

Member Function Documentation

__iter__()

Self homeassistant.components.stream.worker.PeekIterator.__iter__

(

self

)

Return an iterator.

Definition at line 416 of file worker.py.

__next__()

av.Packet homeassistant.components.stream.worker.PeekIterator.__next__

(

self

)

Return and consume the next item available.

Definition at line 420 of file worker.py.

_pop_buffer()

av.Packet homeassistant.components.stream.worker.PeekIterator._pop_buffer (   self )

private

Consume items from the buffer until exhausted.

Definition at line 424 of file worker.py.

peek()

Generator[av.Packet] homeassistant.components.stream.worker.PeekIterator.peek

(

self

)

Return items without consuming from the iterator.

Definition at line 432 of file worker.py.

Member Data Documentation

_iterator

homeassistant.components.stream.worker.PeekIterator._iterator

private

Definition at line 411 of file worker.py.

_next

homeassistant.components.stream.worker.PeekIterator._next

private

Definition at line 414 of file worker.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/stream/worker.py