t.v.a.s.FileSystemLeafStream(SimpleStream) : class documentation

Part of twisted.vfs.adapters.stream View Source View In Hierarchy

Implements interfaces: twisted.web2.stream.IByteStream

No class docstring
Method __init__ Create the stream from leaf. If you specify start and length, use only that portion of the leaf.
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.

Inherited from SimpleStream:

Method split Split this stream into two, at byte position 'point'.
def __init__(self, leaf, start=0, length=None): (source)
Create the stream from leaf. If you specify start and length, use only that portion of the leaf.
def read(self): (source)
from twisted.web2.stream.IByteStream
overrides twisted.web2.stream.SimpleStream.read

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
overrides twisted.web2.stream.SimpleStream.close
Prematurely close this stream. Should also cause further reads to return None. Additionally, .length should be set to 0.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.