t.w.s.SimpleStream(object) : class documentation

Part of twisted.web2.stream View Source View In Hierarchy

Known subclasses: twisted.vfs.adapters.stream.FileSystemLeafStream, twisted.web2.stream.FileStream, twisted.web2.stream.MemoryStream

Implements interfaces: twisted.web2.stream.IByteStream

Superclass of simple streams with a single buffer and a offset and length into that buffer.
Method read Read some data.
Method close Prematurely close this stream. Should also cause further reads to return None. Additionally, .length should be set to 0.
Method split Split this stream into two, at byte position 'point'.
def read(self): (source)
from twisted.web2.stream.IByteStream
overridden in twisted.vfs.adapters.stream.FileSystemLeafStream, twisted.web2.stream.FileStream, twisted.web2.stream.MemoryStream

Read some data.

Returns an object conforming to the buffer interface, or if there is no more data available, returns None. Can also return a Deferred resulting in one of the above.

Errors may be indicated by exception or by a Deferred of a Failure.
def close(self): (source)
from twisted.web2.stream.IByteStream
overridden in twisted.vfs.adapters.stream.FileSystemLeafStream, twisted.web2.stream.FileStream, twisted.web2.stream.MemoryStream
Prematurely close this stream. Should also cause further reads to return None. Additionally, .length should be set to 0.
def split(self, point): (source)
from twisted.web2.stream.IByteStream

Split this stream into two, at byte position 'point'.

Returns a tuple of (before, after). After calling split, no other methods should be called on this stream. Doing so will have undefined behavior.

If you cannot implement split easily, you may implement it as: 
   return fallbackSplit(self, point)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.