Go to the latest version of this document.
search in docstrings

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”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +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”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`telnet`.`Telnet`.`_OptionState`.`_Perspective``

class documentation

`class _Perspective: (source)`

View In Hierarchy

Represents the state of an option on side of the telnet connection. Some options can be enabled on a particular side of the connection (RFC 1073 for example: only the client can have NAWS enabled). Other options can be enabled on either or both sides (such as RFC 1372: each side can have its own flow control state).

Method | `__str__` | Undocumented
Instance Variable | `negotiating` | A boolean tracking whether negotiation about this option is in progress.
Instance Variable | `onResult` | When negotiation about this option has been initiated by this side of the connection, a `Deferred` which will fire with the result of the negotiation. `None` at other times.
Instance Variable | `state` | `'yes'` or `'no'` indicating whether or not this option is enabled on one side of the connection.

def __str__(self): (source)

Undocumented

Returns
`str` | Undocumented

negotiating: `bool` = (source)

A boolean tracking whether negotiation about this option is in progress.

onResult = (source)

When negotiation about this option has been initiated by this side of the connection, a `Deferred` which will fire with the result of the negotiation. `None` at other times.

state: `str` = (source)

`'yes'` or `'no'` indicating whether or not this option is enabled on one side of the connection.