Stream

All Known Implementing Classes:

ChannelStream, CRLFStreamWrapper
```
public interface Stream
```

Field Summary

Fields
Modifier and Type	Field and Description
`static org.jruby.util.ByteList`	`PARAGRAPH_DELIMETER`
`static org.jruby.util.ByteList`	`PARAGRAPH_SEPARATOR`
`static int`	`SEEK_CUR`
`static int`	`SEEK_END`
`static int`	`SEEK_SET`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearerr()`
`void`	`fclose()`
`boolean`	`feof()` Return true when at end of file (EOF).
`int`	`fflush()`
`int`	`fgetc()`
`long`	`fgetpos()` Get the current position within the file associated with this handler.
`org.jruby.util.ByteList`	`fgets(org.jruby.util.ByteList separatorString)`
`void`	`fputc(int c)`
`org.jruby.util.ByteList`	`fread(int number)`
`void`	`freopen(Ruby runtime, java.lang.String path, ModeFlags modes)`
`void`	`ftruncate(long newLength)`
`int`	`fwrite(org.jruby.util.ByteList string)`
`java.nio.channels.Channel`	`getChannel()`
`ChannelDescriptor`	`getDescriptor()`
`int`	`getline(org.jruby.util.ByteList dst, byte terminator)` Read all bytes up to and including a terminator byte.
`int`	`getline(org.jruby.util.ByteList dst, byte terminator, long limit)` Reads all bytes up to and including a terminator byte or until limit is reached.
`ModeFlags`	`getModes()`
`boolean`	`isAutoclose()`
`boolean`	`isBinmode()`
`boolean`	`isBlocking()`
`boolean`	`isSync()`
`void`	`lseek(long offset, int type)` Perform a seek based on pos().
`java.io.InputStream`	`newInputStream()`
`java.io.OutputStream`	`newOutputStream()`
`org.jruby.util.ByteList`	`read(int number)`
`org.jruby.util.ByteList`	`readall()`
`boolean`	`readDataBuffered()`
`int`	`ready()` Implement IO#ready? as per io/wait in MRI.
`void`	`setAutoclose(boolean autoclose)`
`void`	`setBinmode()`
`void`	`setBlocking(boolean blocking)`
`void`	`setModes(ModeFlags modeFlags)`
`void`	`setSync(boolean sync)`
`void`	`sync()` Flush and sync all writes to the filesystem.
`int`	`ungetc(int c)`
`void`	`waitUntilReady()` Implement IO#wait as per io/wait in MRI.
`boolean`	`writeDataBuffered()`

Field Detail

SEEK_SET
```
static final int SEEK_SET
```
See Also:

Constant Field Values

SEEK_CUR
```
static final int SEEK_CUR
```
See Also:

Constant Field Values

SEEK_END
```
static final int SEEK_END
```
See Also:

Constant Field Values

PARAGRAPH_DELIMETER

static final org.jruby.util.ByteList PARAGRAPH_DELIMETER

PARAGRAPH_SEPARATOR

static final org.jruby.util.ByteList PARAGRAPH_SEPARATOR

Method Detail

getDescriptor
```
ChannelDescriptor getDescriptor()
```

clearerr
```
void clearerr()
```

getModes
```
ModeFlags getModes()
```

setModes
```
void setModes(ModeFlags modeFlags)
```

isSync
```
boolean isSync()
```

setSync
```
void setSync(boolean sync)
```

fgets

org.jruby.util.ByteList fgets(org.jruby.util.ByteList separatorString)
                       throws java.io.IOException,
                              BadDescriptorException,
                              java.io.EOFException

Throws:: java.io.IOException; BadDescriptorException; java.io.EOFException

readall

org.jruby.util.ByteList readall()
                         throws java.io.IOException,
                                BadDescriptorException,
                                java.io.EOFException

Throws:: java.io.IOException; BadDescriptorException; java.io.EOFException

getline
```
int getline(org.jruby.util.ByteList dst,
            byte terminator)
     throws java.io.IOException,
            BadDescriptorException
```
Read all bytes up to and including a terminator byte.
If the terminator byte is found, it will be the last byte in the output buffer.

Parameters:

dst - The output buffer.

terminator - The byte to terminate reading.

Returns:

The number of bytes read, or -1 if EOF is reached.

Throws:

java.io.IOException

BadDescriptorException

getline
```
int getline(org.jruby.util.ByteList dst,
            byte terminator,
            long limit)
     throws java.io.IOException,
            BadDescriptorException
```
Reads all bytes up to and including a terminator byte or until limit is reached.
If the terminator byte is found, it will be the last byte in the output buffer.

Parameters:

dst - The output buffer.

terminator - The byte to terminate reading.

limit - the number of bytes to read unless EOF or terminator is found

Returns:

The number of bytes read, or -1 if EOF is reached.

Throws:

java.io.IOException

BadDescriptorException

fread

org.jruby.util.ByteList fread(int number)
                       throws java.io.IOException,
                              BadDescriptorException,
                              java.io.EOFException

Throws:: java.io.IOException; BadDescriptorException; java.io.EOFException

fwrite

int fwrite(org.jruby.util.ByteList string)
    throws java.io.IOException,
           BadDescriptorException

Throws:: java.io.IOException; BadDescriptorException

fgetc

int fgetc()
   throws java.io.IOException,
          BadDescriptorException,
          java.io.EOFException

Throws:: java.io.IOException; BadDescriptorException; java.io.EOFException

ungetc
```
int ungetc(int c)
```

fputc

void fputc(int c)
    throws java.io.IOException,
           BadDescriptorException

Throws:: java.io.IOException; BadDescriptorException

read

org.jruby.util.ByteList read(int number)
                      throws java.io.IOException,
                             BadDescriptorException,
                             java.io.EOFException

Throws:: java.io.IOException; BadDescriptorException; java.io.EOFException

fclose

void fclose()
     throws java.io.IOException,
            BadDescriptorException

Throws:: java.io.IOException; BadDescriptorException

fflush

int fflush()
    throws java.io.IOException,
           BadDescriptorException

Throws:: java.io.IOException; BadDescriptorException

sync
```
void sync()
   throws java.io.IOException,
          BadDescriptorException
```
Flush and sync all writes to the filesystem.

Throws:

java.io.IOException - if the sync does not work

BadDescriptorException

feof
```
boolean feof()
      throws java.io.IOException,
             BadDescriptorException
```
Return true when at end of file (EOF).

Returns:

true if at EOF; false otherwise

Throws:

java.io.IOException

BadDescriptorException

fgetpos
```
long fgetpos()
      throws java.io.IOException,
             PipeException,
             BadDescriptorException,
             InvalidValueException
```
Get the current position within the file associated with this handler.

Returns:

the current position in the file.

Throws:

java.io.IOException

PipeException - ESPIPE (illegal seek) when not a file

BadDescriptorException

InvalidValueException

lseek

void lseek(long offset,
           int type)
    throws java.io.IOException,
           InvalidValueException,
           PipeException,
           BadDescriptorException

Perform a seek based on pos().

Throws:: java.io.IOException; PipeException; InvalidValueException; BadDescriptorException

ftruncate

void ftruncate(long newLength)
        throws java.io.IOException,
               PipeException,
               InvalidValueException,
               BadDescriptorException

Throws:: java.io.IOException; PipeException; InvalidValueException; BadDescriptorException

ready
```
int ready()
   throws java.io.IOException
```
Implement IO#ready? as per io/wait in MRI. returns non-nil if input available without blocking, or nil.

Throws:

java.io.IOException

waitUntilReady
```
void waitUntilReady()
             throws java.io.IOException,
                    java.lang.InterruptedException
```
Implement IO#wait as per io/wait in MRI. waits until input available or timed out and returns self, or nil when EOF reached. The default implementation loops while ready returns 0.

Throws:

java.io.IOException

java.lang.InterruptedException

readDataBuffered
```
boolean readDataBuffered()
```

writeDataBuffered
```
boolean writeDataBuffered()
```

newInputStream
```
java.io.InputStream newInputStream()
```

newOutputStream
```
java.io.OutputStream newOutputStream()
```

isBlocking
```
boolean isBlocking()
```

setBlocking

void setBlocking(boolean blocking)
          throws java.io.IOException

Throws:: java.io.IOException

freopen

void freopen(Ruby runtime,
             java.lang.String path,
             ModeFlags modes)
      throws DirectoryAsFileException,
             java.io.IOException,
             InvalidValueException,
             PipeException,
             BadDescriptorException

Throws:: DirectoryAsFileException; java.io.IOException; InvalidValueException; PipeException; BadDescriptorException

setBinmode
```
void setBinmode()
```

isBinmode
```
boolean isBinmode()
```

getChannel
```
java.nio.channels.Channel getChannel()
```

isAutoclose
```
boolean isAutoclose()
```

setAutoclose
```
void setAutoclose(boolean autoclose)
```

Interface Stream

Field Summary

Method Summary

Field Detail

SEEK_SET

SEEK_CUR

SEEK_END

PARAGRAPH_DELIMETER

PARAGRAPH_SEPARATOR

Method Detail

getDescriptor

clearerr

getModes

setModes

isSync

setSync

fgets

readall

getline

getline

fread

fwrite

fgetc

ungetc

fputc

read

fclose

fflush

sync

feof

fgetpos

lseek

ftruncate

ready

waitUntilReady

readDataBuffered

writeDataBuffered

newInputStream

newOutputStream

isBlocking

setBlocking

freopen

setBinmode

isBinmode

getChannel

isAutoclose

setAutoclose