From 585775bf118ea8c3450ceaf1fa849140eabf8bd7 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Fri, 14 Jun 2002 00:33:02 +0000 Subject: [PATCH] Document the Binary.data attribute. This closes SF bug #562878. --- Doc/lib/libxmlrpclib.tex | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/Doc/lib/libxmlrpclib.tex b/Doc/lib/libxmlrpclib.tex index 0c25c027bbd..8b26a1faa05 100644 --- a/Doc/lib/libxmlrpclib.tex +++ b/Doc/lib/libxmlrpclib.tex @@ -177,20 +177,28 @@ It also supports certain of Python's built-in operators through \subsection{Binary Objects \label{binary-objects}} This class may initialized from string data (which may include NULs). -It has the following methods, supported mainly for internal use by the -marshalling/unmarshalling code: +The primary acess to the content of a \class{Binary} object is +provided by an attribute: -\begin{methoddesc}{decode}{string} +\begin{memberdesc}[Binary]{data} +The binary data encapsulated by the \class{Binary} instance. The data +is provided as an 8-bit string. +\end{memberdesc} + +\class{Binary} objects have the following methods, supported mainly +for internal use by the marshalling/unmarshalling code: + +\begin{methoddesc}[Binary]{decode}{string} Accept a base64 string and decode it as the instance's new data. \end{methoddesc} -\begin{methoddesc}{encode}{out} +\begin{methoddesc}[Binary]{encode}{out} Write the XML-RPC base 64 encoding of this binary item to the out stream object. \end{methoddesc} It also supports certain of Python's built-in operators through a -\method{_cmp__} method. +\method{_cmp__()} method. \subsection{Fault Objects \label{fault-objects}}