Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 585775b

Browse files
committed
Document the Binary.data attribute.
This closes SF bug #562878.
1 parent 9c92b69 commit 585775b

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

Doc/lib/libxmlrpclib.tex

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -177,20 +177,28 @@ \subsection{DateTime Objects \label{datetime-objects}}
177177
\subsection{Binary Objects \label{binary-objects}}
178178

179179
This class may initialized from string data (which may include NULs).
180-
It has the following methods, supported mainly for internal use by the
181-
marshalling/unmarshalling code:
180+
The primary acess to the content of a \class{Binary} object is
181+
provided by an attribute:
182182

183-
\begin{methoddesc}{decode}{string}
183+
\begin{memberdesc}[Binary]{data}
184+
The binary data encapsulated by the \class{Binary} instance. The data
185+
is provided as an 8-bit string.
186+
\end{memberdesc}
187+
188+
\class{Binary} objects have the following methods, supported mainly
189+
for internal use by the marshalling/unmarshalling code:
190+
191+
\begin{methoddesc}[Binary]{decode}{string}
184192
Accept a base64 string and decode it as the instance's new data.
185193
\end{methoddesc}
186194

187-
\begin{methoddesc}{encode}{out}
195+
\begin{methoddesc}[Binary]{encode}{out}
188196
Write the XML-RPC base 64 encoding of this binary item to the out
189197
stream object.
190198
\end{methoddesc}
191199

192200
It also supports certain of Python's built-in operators through a
193-
\method{_cmp__} method.
201+
\method{_cmp__()} method.
194202

195203

196204
\subsection{Fault Objects \label{fault-objects}}

0 commit comments

Comments
 (0)