io vocabulary - Factor Documentation (original) (raw)
Documentation
Streams
Metadata
| Authors: | Slava Pestov |
|---|
Words
Tuple classes
| Class | Superclass | Slots |
|---|---|---|
 bad-seek-type |
 tuple |
type |
Singleton classes
 seek-absolute |
|---|
| seek-end |
| seek-relative |
Mixin classes
| input-stream |
|---|
| output-stream |
Generic words
| Word | Stack effect |
|---|---|
 stream-contents* |
( stream -- seq ) |
| stream-element-type |
( stream -- type ) |
| stream-flush |
( stream -- ) |
| stream-length |
( stream -- n/f ) |
| stream-nl |
( stream -- ) |
| stream-read-partial-unsafe |
( n buf stream -- count ) |
| stream-read-unsafe |
( n buf stream -- count ) |
| stream-read-until |
( seps stream -- seq sep/f ) |
| stream-read1 |
( stream -- elt ) |
| stream-readln |
( stream -- str/f ) |
| stream-seek |
( n seek-type stream -- ) |
| stream-seekable? |
( stream -- ? ) |
| stream-tell |
( stream -- n ) |
| stream-write |
( data stream -- ) |
| stream-write1 |
( elt stream -- ) |
Symbol words
| +byte+ |
|---|
| +character+ |
| error-stream |
Ordinary words
| Word | Stack effect |
|---|---|
| (each-stream-block) |
( ... stream quot: ( ... block -- ... ) block-size -- ... ) |
| (each-stream-block-slice) |
( ... stream quot: ( ... block-slice -- ... ) block-size -- ... ) |
| bad-seek-type |
( type -- * ) |
| bl |
( -- ) |
 default-block-size |
( -- value ) |
| each-block |
( ... quot: ( ... block -- ... ) -- ... ) |
| each-block-slice |
( ... quot: ( ... block -- ... ) -- ... ) |
| each-line |
( ... quot: ( ... line -- ... ) -- ... ) |
| each-stream-block |
( ... stream quot: ( ... block -- ... ) -- ... ) |
| each-stream-block-slice |
( ... stream quot: ( ... block-slice -- ... ) -- ... ) |
| each-stream-line |
( ... stream quot: ( ... line -- ... ) -- ... ) |
| flush |
( -- ) |
| nl |
( -- ) |
| print |
( str -- ) |
| read |
( n -- seq ) |
| read-contents |
( -- seq ) |
| read-into |
( buf -- buf-slice more? ) |
| read-lines |
( -- seq ) |
| read-partial |
( n -- seq ) |
| read-partial-into |
( buf -- buf-slice more? ) |
| read-until |
( seps -- seq sep/f ) |
| read1 |
( -- elt ) |
| readln |
( -- str/f ) |
| seek-input |
( n seek-type -- ) |
| seek-output |
( n seek-type -- ) |
| stream-bl |
( stream -- ) |
| stream-contents |
( stream -- seq ) |
| stream-copy |
( in out -- ) |
| stream-copy* |
( in out -- ) |
| stream-lines |
( stream -- seq ) |
| stream-print |
( str stream -- ) |
| stream-read |
( n stream -- seq/f ) |
| stream-read-into |
( buf stream -- buf-slice more? ) |
| stream-read-partial |
( n stream -- seq/f ) |
| stream-read-partial-into |
( buf stream -- buf-slice more? ) |
| tell-input |
( -- n ) |
| tell-output |
( -- n ) |
| with-error-stream |
( stream quot -- ) |
| with-error-stream* |
( stream quot -- ) |
| with-error>output |
( quot -- ) |
| with-input-output+error-streams |
( input output+error quot -- ) |
| with-input-output+error-streams* |
( input output+error quot -- ) |
| with-input-stream |
( stream quot -- ) |
| with-input-stream* |
( stream quot -- ) |
| with-output+error-stream |
( stream quot -- ) |
| with-output+error-stream* |
( stream quot -- ) |
| with-output-stream |
( stream quot -- ) |
| with-output-stream* |
( stream quot -- ) |
| with-output>error |
( quot -- ) |
| with-streams |
( input output quot -- ) |
| with-streams* |
( input output quot -- ) |
| write |
( seq -- ) |
| write1 |
( elt -- ) |
Class predicate words
| Word | Stack effect |
|---|---|
| bad-seek-type? |
( object -- ? ) |
| input-stream? |
( object -- ? ) |
| output-stream? |
( object -- ? ) |
| seek-absolute? |
( object -- ? ) |
| seek-end? |
( object -- ? ) |
| seek-relative? |
( object -- ? ) |
Files
resource:core/io/io.factor
resource:core/io/io-docs.factor
resource:core/io/io-tests.factor
Metadata files
resource:core/io/authors.txt
resource:core/io/summary.txt
Children from resource:core
| Vocabulary | Summary |
|---|---|
 io.backend |
Hooks for native I/O implementation |
| io.encodings |
Common support for ASCII, UTF8 and UTF16 character encodings |
| io.files |
Reading and writing files |
| io.pathnames |
Pathname manipulation |
 io.streams |
|
| io.test |
Children from resource:basis
| Vocabulary | Summary |
|---|---|
| io.backend |
Hooks for native I/O implementation |
| io.buffers |
High-performance pinned FIFO buffers |
| io.crlf |
Writing with and reading until \r\n |
| io.directories |
Listing directories, moving, copying and deleting files |
| io.encodings |
Common support for ASCII, UTF8 and UTF16 character encodings |
| io.files |
Reading and writing files |
| io.launcher |
Launching operating system processes |
| io.mmap |
Memory-mapped files |
| io.monitors |
File alteration monitoring |
| io.pipes |
Pipes for inter-process communication |
| io.pools |
Abstract connection pooling |
| io.ports |
Low-level implementation support for native I/O |
| io.servers |
Multi-threaded TCP/IP servers |
| io.sockets |
Client and server TCP/IP sockets, UDP/IP datagram sockets |
| io.standard-paths |
|
| io.streams |
|
| io.styles |
Styles which can be used to mark up text sent to an output stream |
| io.thread |
|
| io.timeouts |
Low-level support for setting timeouts on I/O operations |
Children from resource:extra
| Vocabulary | Summary |
|---|---|
| io.encodings |
Common support for ASCII, UTF8 and UTF16 character encodings |
| io.files |
Reading and writing files |
| io.random |
|
| io.serial |
Serial port library |
| io.streams |