Search bar offers the following options:
Term presence. The below example searches for documents that
must contain “foo”, might contain “bar” and must not contain “baz”:
+foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”:
Search in specific fields. The following search matches all objects
in "twisted.mail" that matches “search”:
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents
that have a word within 1 edit distance of “foo”:
Results provided by Lunr.js
class ProtocolToConsumerAdapter(components.Adapter): (source)
||Register to receive data from a producer.|
||Stop consuming data from a producer, without disconnecting.|
||The producer will write data by calling this method.|
||I forward __conform__ to self.original if it has it, otherwise I simply return None.|
||Set my 'original' attribute to be the object I am adapting.|
||Forward isuper to self.original|
||If this adapter is persistent, should it be automatically registered for all appropriate interfaces.|
||If this is True, the adapter will not be persisted on the Componentized.|
Register to receive data from a producer.
This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().
IPullProducer providers, resumeProducing will be called once each time data is required.
IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties. The consumer will only call resumeProducing to balance a previous pauseProducing call; the producer is assumed to start in an un-paused state.
|streaming||True if producer provides |
|If a producer is already registered.|
Stop consuming data from a producer, without disconnecting.
The producer will write data by calling this method.
The implementation must be non-blocking and perform whatever buffering is necessary. If the producer has provided enough data for now and it is a
IPushProducer, the consumer may call its pauseProducing method.