summaryrefslogtreecommitdiff
path: root/doc/rdata-class.rst
diff options
context:
space:
mode:
authorBob Halley <halley@dnspython.org>2017-01-05 06:45:13 -0800
committerBob Halley <halley@dnspython.org>2017-01-05 06:45:13 -0800
commit862d8d7c4d87726c305766d627de1951c78d847c (patch)
treef2cec9b9729f6de1d8cb032ed2f8f3cc5dea2d76 /doc/rdata-class.rst
parent16bf0c46c1df1c979f957ea928ca0df51a4a4e5f (diff)
downloaddnspython-862d8d7c4d87726c305766d627de1951c78d847c.tar.gz
rdata doco
Diffstat (limited to 'doc/rdata-class.rst')
-rw-r--r--doc/rdata-class.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/rdata-class.rst b/doc/rdata-class.rst
new file mode 100644
index 0000000..fbe0004
--- /dev/null
+++ b/doc/rdata-class.rst
@@ -0,0 +1,14 @@
+.. _rdata-class:
+
+DNS Rdata Base Class
+====================
+
+All Rdata objects are instances of some subclass of ``dns.rdata.Rdata``.
+The Rdata factory functions described in :ref:`rdata-make` will create
+objects which are instances of the most appropriate subclass. For example,
+a AAAA record will be an instance of the ``dns.rdtypes.IN.AAAA`` class,
+but a record of TYPE12345, which we don't know anything specific about,
+will be an instance of ``dns.rdata.GenericRdata``.
+
+.. autoclass:: dns.rdata.Rdata
+ :members: