doc scheme/gui editor-stream method updates
svn: r14538
This commit is contained in:
parent
d33f47a625
commit
a99c653997
|
@ -37,6 +37,14 @@ Reads bytes to fill the supplied byte string. The return value is the
|
|||
next call to @method[editor-stream-in-base% bad?] must return
|
||||
@scheme[#t].}
|
||||
|
||||
@defmethod[(read-byte) (or/c byte? #f)]{
|
||||
|
||||
Reads a single byte and return it, or returns @scheme[#f] if no more
|
||||
bytes are available. The default implementation of this method uses
|
||||
@method[editor-stream-in-base% read-bytes].
|
||||
|
||||
}
|
||||
|
||||
@defmethod[(seek [pos exact-nonnegative-integer?])
|
||||
void?]{
|
||||
|
||||
|
|
|
@ -54,12 +54,18 @@ Returns the next integer value in the stream.
|
|||
@defmethod[(get-fixed [v (box/c (and/c exact? integer?))])
|
||||
(is-a?/c editor-stream-in%)]{
|
||||
|
||||
@boxisfill[(scheme v) @elem{a fixed-size integer from the stream obtained through
|
||||
@method[editor-stream-in% get-fixed-exact]}]
|
||||
|
||||
}
|
||||
|
||||
@defmethod[(get-fixed-exact)
|
||||
(and/c exact? integer?)]{
|
||||
|
||||
Gets a fixed-sized integer from the stream. See
|
||||
@method[editor-stream-out% put-fixed] for more information.
|
||||
Reading from a bad stream always gives @scheme[0].
|
||||
|
||||
@boxisfill[(scheme v) @elem{the fixed-size integer from the stream}]
|
||||
|
||||
}
|
||||
|
||||
@defmethod[(get-inexact)
|
||||
|
|
|
@ -86,7 +86,8 @@ Puts a fixed-sized integer into the stream. This method is needed
|
|||
fixed-size number.
|
||||
|
||||
Numbers written to a stream with @method[editor-stream-out% put-fixed]
|
||||
must be read with @method[editor-stream-in% get-fixed].}
|
||||
must be read with @method[editor-stream-in% get-fixed-exact]
|
||||
or @method[editor-stream-in% get-fixed].}
|
||||
|
||||
|
||||
@defmethod[(put-unterminated [v bytes?]) (is-a?/c editor-stream-out%)]{
|
||||
|
|
Loading…
Reference in New Issue
Block a user