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
This interface is really only useful in the context of the plugin system for
endpoints.clientFromString. See the document entitled "The Twisted Plugin System" for more details on how to write a plugin.
If you place an
IStreamClientEndpointStringParserWithReactor plugin in the twisted.plugins package, that plugin's parseStreamClient method will be used to produce endpoints for any description string that begins with the result of that
IStreamClientEndpointStringParserWithReactor's prefix attribute.
||This method is invoked by
IStreamClientEndpoint: (source) ¶
|reactor:||The reactor passed to |
|*args:||The byte string arguments, minus the endpoint type, in the endpoint description string, parsed according to the rules described in |
|**kwargs:||The byte string arguments from the endpoint description passed as keyword arguments. For example, if the description were b"my-type:foo:bar:baz=qux", kwargs would be dict(baz=b'qux').|
|a client endpoint|