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``

class documentation

`class _OptionState: (source)`

View In Hierarchy

Represents the state of an option on both sides of a telnet connection.

Method | `__init__` | Undocumented
Method | `__repr__` | Undocumented
Instance Variable | `him` | The state of the option on the other side of the connection.
Instance Variable | `us` | The state of the option on this side of the connection.
Class | `_Perspective` | 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).

def __init__(self): (source)

Undocumented

def __repr__(self) -> `str`: (source)

Undocumented

him = (source)

The state of the option on the other side of the connection.

us = (source)

The state of the option on this side of the connection.