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

class documentation

`class Name: (source)`

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

View In Hierarchy

A name in the domain name system, made up of multiple labels. For example, twistedmatrix.com.

Method | `__eq__` | Undocumented
Method | `__hash__` | Undocumented
Method | `__init__` | No summary
Method | `__str__` | Represent this `Name` instance by its string name.
Method | `decode` | Decode a byte string into this Name.
Method | `encode` | Encode this Name into the appropriate byte format.
Instance Variable | `name` | A byte string giving the name.

def __eq__(self, other): (source)

Undocumented

Parameters
other:`object` | Undocumented
Returns
`bool` | Undocumented

def __hash__(self): (source)

Undocumented

def __init__(self, name=b''): (source)

Parameters
name:`bytes` or `str` | A name.

def __str__(self): (source)

Represent this `Name` instance by its string name.

Returns
`str` | Undocumented

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

Decode a byte string into this Name.

Parameters
strio:file | Bytes will be read from this file until the full Name is decoded.
length | Undocumented
Raises
`EOFError` | Raised when there are not enough bytes available from `strio`.
`ValueError` | Raised when the name cannot be decoded (for example, because it contains a loop).

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

Encode this Name into the appropriate byte format.

Parameters
strio:file | The byte representation of this Name will be written to this file.
compDict:dict | dictionary of Names that have already been encoded and whose addresses may be backreferenced by this Name (for the purpose of reducing the message size).

name: `bytes` = (source)

A byte string giving the name.