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`.`names`.`dns`.`_OPTVariableOption``

class documentation

`class _OPTVariableOption(tputil.FancyStrMixin, tputil.FancyEqMixin): (source)`

Implements interfaces: `twisted.names.dns.IEncodable`

View In Hierarchy

A class to represent OPT record variable options.

See Also
`_OPTVariableOption.__init__` for documentation of public instance attributes.
https://tools.ietf.org/html/rfc6891#section-6.1.2
Present Since
13.2

Method | `__init__` | No summary
Method | `decode` | Decode bytes into an `_OPTVariableOption` instance.
Method | `encode` | Encode this `_OPTVariableOption` to bytes.
Class Variable | `compareAttributes` | Undocumented
Class Variable | `showAttributes` | Undocumented
Instance Variable | `code` | Undocumented
Instance Variable | `data` | Undocumented
Class Variable | `_fmt` | Undocumented

Inherited from `FancyStrMixin`:

Method | `__str__` | Undocumented

Inherited from `FancyEqMixin` (via `FancyStrMixin`):

Method | `__eq__` | Undocumented
Method | `__ne__` | Undocumented

def __init__(self, code=0, data=b''): (source)

Parameters
code:`int` | The option code
data:`bytes` | The option data

def decode(self, strio, length=None): (source)
from `twisted.names.dns.IEncodable`

Decode bytes into an `_OPTVariableOption` instance.

Parameters
strio:file | Bytes will be read from this file until the full `_OPTVariableOption` is decoded.
length:`int` or `None` | Not used.

def encode(self, strio, compDict=None): (source)
from `twisted.names.dns.IEncodable`

Encode this `_OPTVariableOption` to bytes.

Parameters
strio:file | the byte representation of this `_OPTVariableOption` will be written to this file.
compDict:`dict` or `None` | A dictionary of backreference addresses that have already been written to this stream and that may be used for DNS name compression.

compareAttributes: `tuple[str, ...]` = (source)
overrides `twisted.python.util.FancyEqMixin.compareAttributes`

Undocumented

showAttributes = (source)
overrides `twisted.python.util.FancyStrMixin.showAttributes`

Undocumented

code = (source)

Undocumented

data = (source)

Undocumented

_fmt: `str` = (source)

Undocumented