aboutsummaryrefslogtreecommitdiff
path: root/docs/source/pyasn1/type/char/bmpstring.rst
diff options
context:
space:
mode:
authorIlya Etingof <etingof@gmail.com>2017-10-11 22:09:14 +0200
committerGitHub <noreply@github.com>2017-10-11 22:09:14 +0200
commita7d88710444459a9b634a9a0735221b80ceb68c3 (patch)
tree9fe5e0cb41a2d7098499729092e3b022f53730f6 /docs/source/pyasn1/type/char/bmpstring.rst
parent368d2efaf46a863f8c75ddf9878a5559f246a00a (diff)
downloadpyasn1-a7d88710444459a9b634a9a0735221b80ceb68c3.tar.gz
Docs rearrangement (#88)
Docs rearranged, simplified and reworded, Sphinx theme changed.
Diffstat (limited to 'docs/source/pyasn1/type/char/bmpstring.rst')
-rw-r--r--docs/source/pyasn1/type/char/bmpstring.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/source/pyasn1/type/char/bmpstring.rst b/docs/source/pyasn1/type/char/bmpstring.rst
new file mode 100644
index 0000000..3809e9b
--- /dev/null
+++ b/docs/source/pyasn1/type/char/bmpstring.rst
@@ -0,0 +1,17 @@
+
+.. |ASN.1| replace:: BMPString
+
+.. |encoding| replace:: utf-16-be
+
+|ASN.1| type
+------------
+
+.. autoclass:: pyasn1.type.char.BMPString(value=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection(), encoding='us-ascii')
+ :members: isValue, isSameTypeWith, isSuperTypeOf, tagSet, effectiveTagSet, tagMap
+
+ .. note::
+
+ The |ASN.1| type models a Unicode (ISO10646-1) character string implicitly serialized into UTF-16 big endian.
+
+ .. automethod:: pyasn1.type.char.BMPString.clone(value=NoValue(), tagSet=TagSet(), subtypeSpec=ConstraintsIntersection(), encoding='us-ascii')
+ .. automethod:: pyasn1.type.char.BMPString.subtype(value=NoValue(), implicitTag=Tag(), explicitTag=Tag(),subtypeSpec=ConstraintsIntersection(), encoding='us-ascii')