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`.`protocols`.`amp`.`TooLong``

exception documentation

`class TooLong(AmpError): (source)`

View In Hierarchy

One of the protocol's length limitations was violated.

Method | `__init__` | Undocumented
Method | `__repr__` | Undocumented
Instance Variable | `isKey` | true if the string being encoded in a key position, false if it was in a value position.
Instance Variable | `isLocal` | Was the string encoded locally, or received too long from the network? (It's only physically possible to encode "too long" values on the network for keys.)
Instance Variable | `keyName` | If the string being encoded was in a value position, what key was it being encoded for?
Instance Variable | `value` | The string that was too long.

def __init__(self, isKey, isLocal, value, keyName=None): (source)

Undocumented

def __repr__(self): (source)

Undocumented

Returns
`str` | Undocumented

isKey = (source)

true if the string being encoded in a key position, false if it was in a value position.

isLocal = (source)

Was the string encoded locally, or received too long from the network? (It's only physically possible to encode "too long" values on the network for keys.)

keyName = (source)

If the string being encoded was in a value position, what key was it being encoded for?

value = (source)

The string that was too long.