diff options
Diffstat (limited to 'Doc/lib/libstrio.tex')
| -rw-r--r-- | Doc/lib/libstrio.tex | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/Doc/lib/libstrio.tex b/Doc/lib/libstrio.tex index 26fdda1..cf96dbb 100644 --- a/Doc/lib/libstrio.tex +++ b/Doc/lib/libstrio.tex @@ -3,15 +3,21 @@ \stmodindex{StringIO} -This module implements a file-like class, \code{StringIO}, +This module implements a file-like class, \class{StringIO}, that reads and writes a string buffer (also known as \emph{memory files}). See the description on file objects for operations. -When a \code{StringIO} object is created, it can be initialized +\begin{classdesc}{StringIO}{\optional{buffer}} +When a \class{StringIO} object is created, it can be initialized to an existing string by passing the string to the constructor. -If no string is given, the \code{StringIO} will start empty. +If no string is given, the \class{StringIO} will start empty. +\end{classdesc} -The method \code{getvalue()} can be called to retrieve the entire -contents of the ``file'' at any time before the \code{StringIO} -object's \code{close()} method is called. Calling \code{close()} will -free the memory buffer. +\begin{methoddesc}{getvalue}{} +Retrieve the entire contents of the ``file'' at any time before the +\class{StringIO} object's \method{close()} method is called. +\end{methoddesc} + +\begin{methoddesc}{close}{} +Free the memory buffer. +\end{methoddesc} |