~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/GDataInputStream.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\alias{GDataInputStream}
 
2
\alias{gDataInputStream}
 
3
\alias{GDataStreamByteOrder}
 
4
\alias{GDataStreamNewlineType}
 
5
\name{GDataInputStream}
 
6
\title{GDataInputStream}
 
7
\description{Data Input Stream}
 
8
\section{Methods and Functions}{
 
9
\code{\link{gDataInputStreamNew}(base.stream = NULL)}\cr
 
10
\code{\link{gDataInputStreamSetByteOrder}(object, order)}\cr
 
11
\code{\link{gDataInputStreamGetByteOrder}(object)}\cr
 
12
\code{\link{gDataInputStreamSetNewlineType}(object, type)}\cr
 
13
\code{\link{gDataInputStreamGetNewlineType}(object)}\cr
 
14
\code{\link{gDataInputStreamReadByte}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
15
\code{\link{gDataInputStreamReadInt16}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
16
\code{\link{gDataInputStreamReadUint16}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
17
\code{\link{gDataInputStreamReadInt32}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
18
\code{\link{gDataInputStreamReadUint32}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
19
\code{\link{gDataInputStreamReadInt64}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
20
\code{\link{gDataInputStreamReadUint64}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
21
\code{\link{gDataInputStreamReadLine}(object, cancellable = NULL, .errwarn = TRUE)}\cr
 
22
\code{\link{gDataInputStreamReadLineAsync}(object, io.priority, cancellable = NULL, callback, user.data = NULL)}\cr
 
23
\code{\link{gDataInputStreamReadLineFinish}(object, result, .errwarn = TRUE)}\cr
 
24
\code{\link{gDataInputStreamReadUntil}(object, stop.chars, cancellable = NULL, .errwarn = TRUE)}\cr
 
25
\code{\link{gDataInputStreamReadUntilAsync}(object, stop.chars, io.priority, cancellable = NULL, callback, user.data = NULL)}\cr
 
26
\code{\link{gDataInputStreamReadUntilFinish}(object, result, length, .errwarn = TRUE)}\cr
 
27
\code{gDataInputStream(base.stream = NULL)}
 
28
}
 
29
\section{Hierarchy}{\preformatted{GObject
 
30
   +----GInputStream
 
31
         +----GFilterInputStream
 
32
               +----GBufferedInputStream
 
33
                     +----GDataInputStream}}
 
34
\section{Detailed Description}{Data input stream implements \code{\link{GInputStream}} and includes functions for 
 
35
reading structured data directly from a binary input stream.}
 
36
\section{Structures}{\describe{\item{\verb{GDataInputStream}}{
 
37
An implementation of \code{\link{GBufferedInputStream}} that allows for high-level
 
38
data manipulation of arbitrary data (including binary operations).
 
39
 
 
40
 
 
41
 
 
42
}}}
 
43
\section{Convenient Construction}{\code{gDataInputStream} is the equivalent of \code{\link{gDataInputStreamNew}}.}
 
44
\section{Enums and Flags}{\describe{
 
45
\item{\verb{GDataStreamByteOrder}}{
 
46
\code{\link{GDataStreamByteOrder}} is used to ensure proper endianness of streaming data sources
 
47
across various machine architectures.
 
48
 
 
49
\describe{
 
50
\item{\verb{big-endian}}{Selects Big Endian byte order.}
 
51
\item{\verb{little-endian}}{Selects Little Endian byte order.}
 
52
\item{\verb{host-endian}}{Selects endianness based on host machine's architecture.}
 
53
}
 
54
 
 
55
}
 
56
\item{\verb{GDataStreamNewlineType}}{
 
57
\code{\link{GDataStreamNewlineType}} is used when checking for or setting the line endings for a given file.
 
58
 
 
59
\describe{
 
60
\item{\verb{lf}}{Selects "LF" line endings, common on most modern UNIX platforms.}
 
61
\item{\verb{cr}}{Selects "CR" line endings.}
 
62
\item{\verb{cr-lf}}{Selects "CR, LF" line ending, common on Microsoft Windows.}
 
63
\item{\verb{any}}{Automatically try to handle any line ending type.}
 
64
}
 
65
 
 
66
}
 
67
}}
 
68
\section{Properties}{\describe{
 
69
\item{\verb{byte-order} [\code{\link{GDataStreamByteOrder}} : Read / Write]}{
 
70
 
 
71
The byte order.  Default value: G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN
 
72
 
 
73
}
 
74
\item{\verb{newline-type} [\code{\link{GDataStreamNewlineType}} : Read / Write]}{
 
75
 
 
76
The accepted types of line ending.  Default value: G_DATA_STREAM_NEWLINE_TYPE_LF
 
77
 
 
78
}
 
79
}}
 
80
\references{\url{http://library.gnome.org/devel//gio/GDataInputStream.html}}
 
81
\author{Derived by RGtkGen from GTK+ documentation}
 
82
\keyword{internal}