org.jruby.util.io

Interface 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

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, String path, ModeFlags modes)
void	ftruncate(long newLength)
int	fwrite(org.jruby.util.ByteList string)
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().
InputStream	newInputStream()
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 IOException,
                                     BadDescriptorException,
                                     EOFException

Throws:

IOException

BadDescriptorException

EOFException

readall

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

Throws:

IOException

BadDescriptorException

EOFException

getline

int getline(org.jruby.util.ByteList dst,
          byte terminator)
            throws 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:

IOException

BadDescriptorException

getline

int getline(org.jruby.util.ByteList dst,
          byte terminator,
          long limit)
            throws 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:

IOException

BadDescriptorException

fread

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

Throws:

IOException

BadDescriptorException

EOFException

fwrite

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

Throws:

IOException

BadDescriptorException

fgetc

int fgetc()
          throws IOException,
                 BadDescriptorException,
                 EOFException

Throws:

IOException

BadDescriptorException

EOFException

ungetc

int ungetc(int c)

fputc

void fputc(int c)
           throws IOException,
                  BadDescriptorException

Throws:

IOException

BadDescriptorException

read

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

Throws:

IOException

BadDescriptorException

EOFException

fclose

void fclose()
            throws IOException,
                   BadDescriptorException

Throws:

IOException

BadDescriptorException

fflush

int fflush()
           throws IOException,
                  BadDescriptorException

Throws:

IOException

BadDescriptorException

sync

void sync()
          throws IOException,
                 BadDescriptorException

Flush and sync all writes to the filesystem.

Throws:

IOException - if the sync does not work

BadDescriptorException

feof

boolean feof()
             throws IOException,
                    BadDescriptorException

Return true when at end of file (EOF).

Returns:

true if at EOF; false otherwise

Throws:

IOException

BadDescriptorException

fgetpos

long fgetpos()
             throws IOException,
                    PipeException,
                    BadDescriptorException,
                    InvalidValueException

Get the current position within the file associated with this handler.

Returns:

the current position in the file.

Throws:

IOException

PipeException - ESPIPE (illegal seek) when not a file

BadDescriptorException

InvalidValueException

lseek

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

Perform a seek based on pos().

Throws:

IOException

PipeException

InvalidValueException

BadDescriptorException

ftruncate

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

Throws:

IOException

PipeException

InvalidValueException

BadDescriptorException

ready

int ready()
          throws IOException

Implement IO#ready? as per io/wait in MRI. returns non-nil if input available without blocking, or nil.

Throws:

IOException

waitUntilReady

void waitUntilReady()
                    throws IOException,
                           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:

IOException

InterruptedException

readDataBuffered

boolean readDataBuffered()

writeDataBuffered

boolean writeDataBuffered()

newInputStream

InputStream newInputStream()

newOutputStream

OutputStream newOutputStream()

isBlocking

boolean isBlocking()

setBlocking

void setBlocking(boolean blocking)
                 throws IOException

Throws:

IOException

freopen

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

Throws:

DirectoryAsFileException

IOException

InvalidValueException

PipeException

BadDescriptorException

setBinmode

void setBinmode()

isBinmode

boolean isBinmode()

getChannel

Channel getChannel()

isAutoclose

boolean isAutoclose()

setAutoclose

void setAutoclose(boolean autoclose)