twisted.mail.pop3._IteratorBuffer : API documentation

Instance Variable	write	See `__init__`.
Instance Variable	memoryBufferSize	See `__init__`.
Instance Variable	bufSize	The number of bytes currently in the buffer.
Instance Variable	lines	The buffer, which is a list of strings.
Instance Variable	iterator	An iterator over a container of strings.
Method	__init__
Method	__iter__	Return an iterator.
Method	__next__	Get the next string from the container, buffer it, and possibly send the buffer to the writer.

memoryBufferSize = (source)

The number of bytes currently in the buffer.

(type: int)

The buffer, which is a list of strings.

(type: list of bytes)

iterator = (source)

An iterator over a container of strings.

(type: iterator which yields bytes)

def __init__(self, write, iterable, memoryBufferSize=None): (source)

Parameters	write	A writer which is a callable that takes a list of strings. (type: callable that takes `list` of `bytes`)
	iterable	An iterable container of strings. (type: iterable which yields `bytes`)
	memoryBufferSize	The number of bytes to buffer before flushing the buffer to the writer. (type: `int` or `None`)

def __iter__(self): (source)

Return an iterator.

Returns An iterator over strings. (type: iterator which yields bytes)

def __next__(self): (source)

Get the next string from the container, buffer it, and possibly send the buffer to the writer.

The contents of the buffer are written when it is full or when no further values are available from the container.

Raises StopIteration When no further values are available from the container.