twisted.web._newclient.LengthEnforcingConsumer : API documentation

class documentation

class twisted.web._newclient.LengthEnforcingConsumer: (source)

An IConsumer proxy which enforces an exact length requirement on the total data written to it.

Method	__init__	Undocumented
Method	write	Write `bytes` to the underlying consumer unless `_noMoreWritesExpected` has been called or there are/have been too many bytes.
Instance Variable	_length	The number of bytes remaining to be written.
Instance Variable	_producer	The `IBodyProducer` which is writing to this consumer.
Instance Variable	_consumer	The consumer to which at most `_length` bytes will be forwarded.
Instance Variable	_finished	A `Deferred` which will be fired with a `Failure` if too many bytes are written to this consumer.
Method	_allowNoMoreWrites	Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.
Method	_noMoreWritesExpected	Called to indicate no more bytes will be written to this consumer. Check to see that the correct number have been written.

The number of bytes remaining to be written.

_producer = (source)

The IBodyProducer which is writing to this consumer.

_consumer = (source)

The consumer to which at most _length bytes will be forwarded.

_finished = (source)

A Deferred which will be fired with a Failure if too many bytes are written to this consumer.

def __init__(self, producer, consumer, finished): (source)

Undocumented

def _allowNoMoreWrites(self): (source)

Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.

def write(self, bytes): (source)

Write bytes to the underlying consumer unless _noMoreWritesExpected has been called or there are/have been too many bytes.

def _noMoreWritesExpected(self): (source)

Called to indicate no more bytes will be written to this consumer. Check to see that the correct number have been written.

Raises WrongBodyLength If not enough bytes have been written.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.