Package org.jruby

Class RubyIO

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyIO

All Implemented Interfaces:

Closeable, Flushable, Serializable, AutoCloseable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, IOEncodable

Direct Known Subclasses:

FileDescriptorIO, RubyBasicSocket, RubyFile

public class RubyIO
extends RubyObject
implements IOEncodable, Closeable, Flushable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RubyIO.IOEvent
static class	RubyIO.RubyIOTimeoutError
static class	RubyIO.Sysopen
static class	RubyIO.TimeoutError	Represents a Ruby IO::TimeoutErrorError as a throwable Java exception.

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Nested classes/interfaces inherited from interface org.jruby.util.io.IOEncodable

IOEncodable.ConvConfig

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSED_STREAM_MSG
static final int	FD_CLOEXEC
protected OpenFile	openFile
static final ByteList	PARAGRAPH_SEPARATOR
protected boolean	popenSpecial	If the stream is being used for popen, we don't want to destroy the process when we close the stream.

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
RubyIO(Ruby runtime, InputStream inputStream)
RubyIO(Ruby runtime, OutputStream outputStream)
RubyIO(Ruby runtime, OutputStream outputStream, boolean autoclose)
RubyIO(Ruby runtime, Channel channel)
RubyIO(Ruby runtime, RubyClass type)
RubyIO(Ruby runtime, RubyClass klass, Channel channel)
RubyIO(Ruby runtime, RubyClass cls, ShellLauncher.POpenProcess process, RubyHash options, IOOptions ioOptions)	Deprecated.
RubyIO(Ruby runtime, STDIO stdio)	Deprecated.
RubyIO(Ruby runtime, ShellLauncher.POpenProcess process, IOOptions ioOptions)

Method Summary

Modifier and Type	Method	Description
void	addBlockingThread(RubyThread thread)	Add a thread to the list of blocking threads for this IO.
IRubyObject	advise(ThreadContext context, IRubyObject[] argv)
IRubyObject	autoclose(ThreadContext context)
IRubyObject	autoclose_set(ThreadContext context, IRubyObject autoclose)
IRubyObject	binmode()	Deprecated. Use binmode(ThreadContext) instead.
IRubyObject	binmode(ThreadContext context)
static IRubyObject	binread(ThreadContext context, IRubyObject recv, IRubyObject[] args)	binread is just like read, except it doesn't take options and it forces mode to be "rb:ASCII-8BIT"
static IRubyObject	binwrite(ThreadContext context, IRubyObject recv, IRubyObject[] args)
IRubyObject	bytes(ThreadContext context, Block block)	Deprecated.
IRubyObject	chars(ThreadContext context, Block block)	Deprecated.
static RubyArray	checkExecEnv(ThreadContext context, RubyHash hash)	Deprecated.
static void	checkExecOptions(IRubyObject options)	Deprecated.
protected void	checkLength(ThreadContext context, int len)
static void	checkPopenOptions(IRubyObject options)	Deprecated.
static void	checkSpawnOptions(IRubyObject options)	Deprecated.
static ChannelFD	cloexecOpen(Ruby runtime, RubyIO.Sysopen data)
final void	close()
IRubyObject	close(ThreadContext context)	Closes all open resources for the IO.
IRubyObject	close_on_exec_p(ThreadContext context)
IRubyObject	close_on_exec_set(ThreadContext context, IRubyObject arg)
IRubyObject	close_read(ThreadContext context)
IRubyObject	close_write(ThreadContext context)
RubyBoolean	closed_p(ThreadContext context)
IRubyObject	codepoints(ThreadContext context, Block block)	Deprecated.
static RubyIO	convertToIO(ThreadContext context, IRubyObject obj)
static IRubyObject	copy_stream(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	copy_stream(ThreadContext context, IRubyObject recv, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	copy_stream(ThreadContext context, IRubyObject recv, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
static RubyClass	createIOClass(ThreadContext context, RubyClass Object, RubyModule Enumerable)
protected static int	doRead(ThreadContext context, OpenFile fptr, byte[] buffer, int start, int len)
IRubyObject	doReadNonblock(ThreadContext context, IRubyObject[] args, boolean exception)
IRubyObject	doReadNonblock(ThreadContext context, IRubyObject arg0, boolean exception)
IRubyObject	doReadNonblock(ThreadContext context, IRubyObject arg0, IRubyObject arg1, boolean exception)
IRubyObject	doReadNonblock(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, boolean exception)
IRubyObject	doWriteNonblock(ThreadContext context, IRubyObject[] argv, boolean useException)	Deprecated.
IRubyObject	each(ThreadContext context, Block block)
IRubyObject	each(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	each(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	each(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	each(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
IRubyObject	each_byte(ThreadContext context, Block block)
IRubyObject	each_byteInternal(ThreadContext context, Block block)	Invoke a block for each byte.
IRubyObject	each_char(ThreadContext context, Block block)
IRubyObject	each_charInternal(ThreadContext context, Block block)
IRubyObject	each_codepoint(ThreadContext context, Block block)
IRubyObject	each_line(ThreadContext context, Block block)
IRubyObject	each_line(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	each_line(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	each_line(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	each_line(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
static IRubyObject	ensureYieldClose(ThreadContext context, IRubyObject port, Block block)
static IRubyObject	ensureYieldClosePipes(ThreadContext context, IRubyObject obj, RubyIO r, RubyIO w, Block block)
RubyBoolean	eof_p(ThreadContext context)
IRubyObject	external_encoding(ThreadContext context)
static void	failIfDirectory(Ruby runtime, RubyString pathStr)
IRubyObject	fcntl(ThreadContext context, IRubyObject cmd)
IRubyObject	fcntl(ThreadContext context, IRubyObject cmd, IRubyObject arg)
RubyFixnum	fileno(ThreadContext context)
void	flush()
RubyIO	flush(ThreadContext context)	Flushes the IO output stream.
protected RubyIO	flushRaw(ThreadContext context, boolean sync)
static IRubyObject	for_fd(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
static IRubyObject	foreach(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
RubyFixnum	fsync(ThreadContext context)
boolean	getBlocking()
boolean	getBOM()
IRubyObject	getbyte(ThreadContext context)	Read a byte.
int	getByte(ThreadContext context)
IRubyObject	getc()	Deprecated.
IRubyObject	getc(ThreadContext context)
Channel	getChannel()	Get the underlying channel from this IO object.
int	getEcflags()
IRubyObject	getEcopts()
org.jcodings.Encoding	getEnc()
org.jcodings.Encoding	getEnc2()
org.jcodings.Encoding	getInputEncoding()
InputStream	getInStream()
static ModeFlags	getIOModes(Ruby runtime, String modesString)	Deprecated.
static int	getIOModesIntFromString(Ruby runtime, String modesString)	Deprecated.
IRubyObject	getline(Ruby runtime, ByteList separator)	Deprecated.
IRubyObject	getline(Ruby runtime, ByteList separator, long limit)	Deprecated.
IRubyObject	getline(ThreadContext context, IRubyObject separator)
IRubyObject	getline(ThreadContext context, IRubyObject separator, long limit)	getline using logic of gets.
IRubyObject	getline(ThreadContext context, ByteList separator)	Deprecated.
IRubyObject	getline(ThreadContext context, ByteList separator, long limit)	Deprecated.
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
OpenFile	getOpenFile()
OpenFile	getOpenFileChecked()
OpenFile	getOpenFileInitialized()
OutputStream	getOutStream()
String	getPath()
org.jcodings.Encoding	getReadEncoding()
IRubyObject	gets(ThreadContext context)	Read a line.
IRubyObject	gets(ThreadContext context, IRubyObject arg)
IRubyObject	gets(ThreadContext context, IRubyObject rs, IRubyObject limit_arg)
IRubyObject	gets(ThreadContext context, IRubyObject rs, IRubyObject limit_arg, IRubyObject opt)
boolean	getSync()
RubyIO	GetWriteIO()
IRubyObject	initialize(ThreadContext context, IRubyObject fileNumber, Block unused)
IRubyObject	initialize(ThreadContext context, IRubyObject fileNumber, IRubyObject second, Block unused)
IRubyObject	initialize(ThreadContext context, IRubyObject fileNumber, IRubyObject modeValue, IRubyObject options, Block unused)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject _io)	Initializes this object as a copy of the original, that is the parameter to this object.
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
IRubyObject	internal_encoding(ThreadContext context)
protected static IRubyObject	ioClose(ThreadContext context, IRubyObject io)
IRubyObject	ioctl(ThreadContext context, IRubyObject[] args)
static IRubyObject	ioOpen(ThreadContext context, IRubyObject filename, IRubyObject vmode, IRubyObject vperm, IRubyObject opt)	Deprecated.
static IRubyObject	ioOpen(ThreadContext context, IRubyObject recv, IRubyObject filename, IRubyObject vmode, IRubyObject vperm, IRubyObject opt)
static IRubyObject	ioStaticWrite(ThreadContext context, IRubyObject recv, IRubyObject[] argv, boolean binary)
boolean	isAutoclose()
boolean	isClosed()	Is this IO closed MRI: rb_io_closed
RubyFixnum	lineno(ThreadContext context)	Returns the current line number.
RubyFixnum	lineno_set(ThreadContext context, IRubyObject newLineNumber)	Sets the current line number.
IRubyObject	lines(ThreadContext context, Block block)	Deprecated.
final OpenFile	MakeOpenFile()
static IRubyObject	newInstance(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
static RubyIO	newIO(Ruby runtime, Channel channel)
static IOOptions	newIOOptions(Ruby runtime, int mode)
static IOOptions	newIOOptions(Ruby runtime, long mode)
static IOOptions	newIOOptions(Ruby runtime, String mode)
static IOOptions	newIOOptions(Ruby runtime, IOOptions oldFlags, int orOflags)
static IOOptions	newIOOptions(Ruby runtime, ModeFlags modeFlags)
static ModeFlags	newModeFlags(Ruby runtime, int mode)
static ModeFlags	newModeFlags(Ruby runtime, long mode)
static ModeFlags	newModeFlags(Ruby runtime, String mode)
static void	obliterateProcess(Process process)	Try for around 1s to destroy the child process.
IRubyObject	op_append(ThreadContext context, IRubyObject anObject)	rb_io_addstr
IRubyObject	op_binmode(ThreadContext context)
static IRubyObject	open(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
protected IOOptions	parseIOOptions(IRubyObject arg)
IRubyObject	path(ThreadContext context)
IRubyObject	pid(ThreadContext context)	Return the process id (pid) of the process this IO object spawned.
static IRubyObject	pipe(ThreadContext context, IRubyObject recv)
static IRubyObject	pipe(ThreadContext context, IRubyObject klass, Block block)
static IRubyObject	pipe(ThreadContext context, IRubyObject klass, IRubyObject[] argv, Block block)	Deprecated.
static IRubyObject	pipe(ThreadContext context, IRubyObject klass, IRubyObject arg0, Block block)
static IRubyObject	pipe(ThreadContext context, IRubyObject klass, IRubyObject arg0, IRubyObject arg1, Block block)
static IRubyObject	pipe(ThreadContext context, IRubyObject klass, IRubyObject v1, IRubyObject v2, IRubyObject opt, Block block)
static IRubyObject	popen(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
static IRubyObject	popen3(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	Deprecated.
static IRubyObject	popen4(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	Deprecated.
static org.jruby.RubyIO.POpenTuple	popenSpecial(ThreadContext context, IRubyObject[] args)	Deprecated.
RubyFixnum	pos(ThreadContext context)
RubyFixnum	pos_set(ThreadContext context, IRubyObject offset)
IRubyObject	pread(ThreadContext context, IRubyObject len, IRubyObject offset)
IRubyObject	pread(ThreadContext context, IRubyObject _length, IRubyObject _from, IRubyObject str)
static RubyIO	prepStdio(Ruby runtime, InputStream f, Channel c, int fmode, RubyClass klass, String path)
static RubyIO	prepStdio(Ruby runtime, OutputStream f, Channel c, int fmode, RubyClass klass, String path)
IRubyObject	print(ThreadContext context)
IRubyObject	print(ThreadContext context, IRubyObject arg0)
IRubyObject	print(ThreadContext context, IRubyObject[] args)	Print some objects to the stream.
IRubyObject	print(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	print(ThreadContext context, IRubyObject out, IRubyObject[] args)	Print some objects to the stream.
IRubyObject	print(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
static IRubyObject	print0(ThreadContext context, IRubyObject out)
static IRubyObject	print1(ThreadContext context, IRubyObject out, IRubyObject arg1)
static IRubyObject	print2(ThreadContext context, IRubyObject out, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	print3(ThreadContext context, IRubyObject out, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	printf(ThreadContext context, IRubyObject[] args)
static IRubyObject	printf(ThreadContext context, IRubyObject out, IRubyObject[] args)
IRubyObject	putc(ThreadContext context, IRubyObject ch)
static IRubyObject	putc(ThreadContext context, IRubyObject maybeIO, IRubyObject object)
IRubyObject	puts(ThreadContext context)
IRubyObject	puts(ThreadContext context, IRubyObject arg0)
IRubyObject	puts(ThreadContext context, IRubyObject[] args)
IRubyObject	puts(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	puts(ThreadContext context, IRubyObject maybeIO, IRubyObject... args)
IRubyObject	puts(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
static IRubyObject	puts0(ThreadContext context, IRubyObject maybeIO)
static IRubyObject	puts1(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0)
static IRubyObject	puts2(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	puts3(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	pwrite(ThreadContext context, IRubyObject str, IRubyObject offset)
protected IRubyObject	rbIoClose(ThreadContext context)
IRubyObject	read(IRubyObject[] args)	Deprecated.
IRubyObject	read(ThreadContext context)	Read all available bytes.
int	read(ThreadContext context, byte[] buffer, int start, int len)	Read into the given buffer starting from start and reading len bytes.
IRubyObject	read(ThreadContext context, IRubyObject length)	Read length bytes.
IRubyObject	read(ThreadContext context, IRubyObject[] args)
IRubyObject	read(ThreadContext context, IRubyObject length, IRubyObject maybeStr)	Read into the given buffer (or create a new one) reading length bytes.
static IRubyObject	read(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	read(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block unusedBlock)
IRubyObject	read_nonblock(ThreadContext context, IRubyObject arg0)
IRubyObject	read_nonblock(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	read_nonblock(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	read_nonblock(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	readbyte(ThreadContext context)
IRubyObject	readchar()	Deprecated.
IRubyObject	readchar(ThreadContext context)	Read a char.
IRubyObject	readline(ThreadContext context)	Read a line.
IRubyObject	readline(ThreadContext context, IRubyObject separator)
IRubyObject	readline(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	readline(ThreadContext context, IRubyObject separator, IRubyObject limit)
IRubyObject	readline(ThreadContext context, IRubyObject separator, IRubyObject limit, IRubyObject opts)
RubyArray	readlines(ThreadContext context)
RubyArray	readlines(ThreadContext context, IRubyObject arg0)
RubyArray	readlines(ThreadContext context, IRubyObject[] args)
RubyArray	readlines(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	readlines(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block unusedBlock)
RubyArray	readlines(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	readpartial(ThreadContext context, IRubyObject arg0)
IRubyObject	readpartial(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	readpartial(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
void	removeBlockingThread(RubyThread thread)	Remove a thread from the list of blocking threads for this IO.
IRubyObject	reopen(ThreadContext context, IRubyObject[] args)
protected RubyIO	reopenIO(ThreadContext context, RubyIO nfile)
RubyFixnum	rewind(ThreadContext context)
RubyFixnum	seek(ThreadContext context, IRubyObject off)
RubyFixnum	seek(ThreadContext context, IRubyObject[] args)
RubyFixnum	seek(ThreadContext context, IRubyObject off, IRubyObject whence)
static IRubyObject	select(ThreadContext context, IRubyObject recv, IRubyObject[] argv)
static IRubyObject	select_static(ThreadContext context, Ruby runtime, IRubyObject[] args)	Deprecated.
IRubyObject	set_encoding(ThreadContext context, IRubyObject encodingObj)
IRubyObject	set_encoding(ThreadContext context, IRubyObject encodingString, IRubyObject internalEncoding)
IRubyObject	set_encoding(ThreadContext context, IRubyObject encodingString, IRubyObject internalEncoding, IRubyObject options)
IRubyObject	set_encoding_by_bom(ThreadContext context)
protected RubyIO	setAscii8bitBinmode()
void	setAutoclose(boolean autoclose)
void	setBlocking(boolean blocking)
void	setBOM(boolean bom)
void	setEcflags(int ecflags)
void	setEcopts(IRubyObject ecopts)
void	setEnc(org.jcodings.Encoding enc)
void	setEnc2(org.jcodings.Encoding enc2)
void	setEncoding(ThreadContext context, IRubyObject v1, IRubyObject v2, IRubyObject opt)
protected void	setPath(String path)
void	setSync(boolean sync)
IRubyObject	stat(ThreadContext context)
RubyBoolean	sync(ThreadContext context)	Returns the current sync mode.
IRubyObject	sync_set(IRubyObject sync)	Deprecated. Use sync_set(ThreadContext, IRubyObject) instead.
IRubyObject	sync_set(ThreadContext context, IRubyObject sync)	Sets the current sync mode.
protected static ChannelFD	sysopen(Ruby runtime, String fname, int oflags, int perm)
static IRubyObject	sysopen(IRubyObject recv, IRubyObject[] args, Block block)	Deprecated.
static IRubyObject	sysopen(ThreadContext context, IRubyObject recv, IRubyObject[] argv, Block block)
IRubyObject	sysread(ThreadContext context, IRubyObject _length)
IRubyObject	sysread(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	sysread(ThreadContext context, IRubyObject _length, IRubyObject _str)
RubyFixnum	sysseek(ThreadContext context, IRubyObject[] args)
IRubyObject	syswrite(ThreadContext context, IRubyObject str)
RubyIO	to_io()
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
String	toString()	The default toString method is just a wrapper that calls the Ruby "to_s" method.
static IRubyObject	tryConvert(ThreadContext context, IRubyObject recv, IRubyObject arg)
RubyBoolean	tty_p(ThreadContext context)
IRubyObject	ungetbyte(ThreadContext context, IRubyObject b)
IRubyObject	ungetc(ThreadContext context, IRubyObject c)
protected IOOptions	updateIOOptionsFromOptions(ThreadContext context, RubyHash options, IOOptions ioOptions)	See http://ruby-doc.org/core-1.9.3/IO.html#method-c-new for the format of modes in options
IRubyObject	wait(ThreadContext context, IRubyObject[] argv)
static IRubyObject	wait(ThreadContext context, IRubyObject _io, IRubyObject[] argv)
IRubyObject	wait_readable(ThreadContext context, IRubyObject[] argv)
static IRubyObject	wait_readable(ThreadContext context, IRubyObject _io, IRubyObject[] argv)
IRubyObject	wait_writable(ThreadContext context, IRubyObject[] argv)	waits until input available or timed out and returns self, or nil when EOF reached.
static IRubyObject	wait_writable(ThreadContext context, IRubyObject _io, IRubyObject[] argv)	waits until input available or timed out and returns self, or nil when EOF reached.
int	write(byte[] bytes, int start, int length, org.jcodings.Encoding encoding)	Same as write(ThreadContext, byte[], int, int, Encoding, boolean) but context will be retrieved and nosync defaults to false.
int	write(byte[] bytes, int start, int length, org.jcodings.Encoding encoding, boolean nosync)	Same as write(ThreadContext, byte[], int, int, Encoding, boolean) but context will be retrieved.
int	write(byte[] bytes, org.jcodings.Encoding encoding)	Same as write(ThreadContext, byte[], int, int, Encoding, boolean) but context will be retrieved nosync defaults to false, and the entire byte array will be written.
void	write(int bite)	Same as write(ThreadContext, byte) but context will be retrieved.
final void	write(ThreadContext context, byte ch)	Write a single byte to this IO's write target but do not return the number of bytes written (it will be 1).
int	write(ThreadContext context, byte[] bytes, int start, int length, org.jcodings.Encoding encoding)	Write the given range of bytes to this IO.
int	write(ThreadContext context, byte[] bytes, int start, int length, org.jcodings.Encoding encoding, boolean nosync)	Write the given range of bytes to this IO.
final IRubyObject	write(ThreadContext context, int ch)	Write a single byte to this IO's write target.
IRubyObject	write(ThreadContext context, IRubyObject str)	Ruby method IO#write(str), equivalent to io_write_m.
IRubyObject	write(ThreadContext context, IRubyObject[] args)	Ruby method IO#write(str, ...), equivalent to io_write_m.
IRubyObject	write(ThreadContext context, IRubyObject str, boolean nosync)	Write the given range of bytes to this IO's write target.
static IRubyObject	write(ThreadContext context, IRubyObject maybeIO, IRubyObject str)
static IRubyObject	write(ThreadContext context, IRubyObject recv, IRubyObject[] argv)
static IRubyObject	write(ThreadContext context, IRubyObject maybeIO, IRubyObject arg0, IRubyObject arg1)
protected static IRubyObject	write(ThreadContext context, IRubyObject maybeIO, ByteList byteList)
protected static IRubyObject	write(ThreadContext context, IRubyObject maybeIO, ByteList byteList, IRubyObject sep)
IRubyObject	write_nonblock(ThreadContext context, IRubyObject arg0)
IRubyObject	write_nonblock(ThreadContext context, IRubyObject[] argv)	Deprecated.
IRubyObject	write_nonblock(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	write2(ThreadContext context, IRubyObject arg0, IRubyObject arg1)	Ruby method IO#write(str, ...), equivalent to io_write_m.
IRubyObject	write3(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)	Ruby method IO#write(str, ...), equivalent to io_write_m.
static IRubyObject	writeStatic(ThreadContext context, IRubyObject recv, IRubyObject[] argv, Block unusedBlock)	Deprecated.
static IRubyObject	writev(ThreadContext context, IRubyObject io)
static IRubyObject	writev(ThreadContext context, IRubyObject io, IRubyObject arg0)
static IRubyObject	writev(ThreadContext context, IRubyObject io, IRubyObject[] args)
static IRubyObject	writev(ThreadContext context, IRubyObject io, IRubyObject arg0, IRubyObject arg1)
static IRubyObject	writev(ThreadContext context, IRubyObject io, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, hashCode, inspect, op_eqq, puts, specificEval, toRubyString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, to_s, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

checkStringType19, dup, marshalLiveVariables

Field Details

PARAGRAPH_SEPARATOR

public static final ByteList PARAGRAPH_SEPARATOR

CLOSED_STREAM_MSG

public static final String CLOSED_STREAM_MSG

See Also:

• Constant Field Values

FD_CLOEXEC

public static final int FD_CLOEXEC

See Also:

• Constant Field Values

openFile

protected OpenFile openFile

popenSpecial

protected boolean popenSpecial

If the stream is being used for popen, we don't want to destroy the process when we close the stream.

Constructor Details

RubyIO

public RubyIO(Ruby runtime,
 RubyClass type)

RubyIO

public RubyIO(Ruby runtime,
 OutputStream outputStream)

RubyIO

public RubyIO(Ruby runtime,
 OutputStream outputStream,
 boolean autoclose)

RubyIO

public RubyIO(Ruby runtime,
 InputStream inputStream)

RubyIO

public RubyIO(Ruby runtime,
 Channel channel)

RubyIO

public RubyIO(Ruby runtime,
 RubyClass klass,
 Channel channel)

RubyIO

public RubyIO(Ruby runtime,
 ShellLauncher.POpenProcess process,
 IOOptions ioOptions)

RubyIO

@Deprecated
public RubyIO(Ruby runtime,
 STDIO stdio)

Deprecated.

RubyIO

@Deprecated
public RubyIO(Ruby runtime,
 RubyClass cls,
 ShellLauncher.POpenProcess process,
 RubyHash options,
 IOOptions ioOptions)

Deprecated.

Method Details

prepStdio

public static RubyIO prepStdio(Ruby runtime,
 InputStream f,
 Channel c,
 int fmode,
 RubyClass klass,
 String path)

prepStdio

public static RubyIO prepStdio(Ruby runtime,
 OutputStream f,
 Channel c,
 int fmode,
 RubyClass klass,
 String path)

newIO

public static RubyIO newIO(Ruby runtime,
 Channel channel)

getOpenFile

public OpenFile getOpenFile()

getOpenFileChecked

public OpenFile getOpenFileChecked()

getOpenFileInitialized

public OpenFile getOpenFileInitialized()

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

Returns:

the ClassIndex of the native type this object was constructed from

See Also:

• ClassIndex

createIOClass

public static RubyClass createIOClass(ThreadContext context,
 RubyClass Object,
 RubyModule Enumerable)

getOutStream

public OutputStream getOutStream()

getInStream

public InputStream getInStream()

getChannel

public Channel getChannel()

Get the underlying channel from this IO object. Note that IO buffers data internally, so the channel returned here may have been read into those buffers. If the channel and the IO are both being used at the same time, the stream will get out of sync.

Returns:

the underlying channel for this IO

reopenIO

protected RubyIO reopenIO(ThreadContext context,
 RubyIO nfile)

reopen

public IRubyObject reopen(ThreadContext context,
 IRubyObject[] args)

getline

public IRubyObject getline(ThreadContext context,
 IRubyObject separator)

getline

public IRubyObject getline(ThreadContext context,
 IRubyObject separator,
 long limit)

getline using logic of gets. If limit is -1 then read unlimited amount.

getEnc

public org.jcodings.Encoding getEnc()

Specified by:

getEnc in interface IOEncodable

getReadEncoding

public org.jcodings.Encoding getReadEncoding()

getEnc2

public org.jcodings.Encoding getEnc2()

Specified by:

getEnc2 in interface IOEncodable

getInputEncoding

public org.jcodings.Encoding getInputEncoding()

newInstance

public static IRubyObject newInstance(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

for_fd

public static IRubyObject for_fd(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject fileNumber,
 Block unused)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject fileNumber,
 IRubyObject second,
 Block unused)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject fileNumber,
 IRubyObject modeValue,
 IRubyObject options,
 Block unused)

parseIOOptions

protected IOOptions parseIOOptions(IRubyObject arg)

external_encoding

public IRubyObject external_encoding(ThreadContext context)

internal_encoding

public IRubyObject internal_encoding(ThreadContext context)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
 IRubyObject encodingObj)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
 IRubyObject encodingString,
 IRubyObject internalEncoding)

set_encoding

public IRubyObject set_encoding(ThreadContext context,
 IRubyObject encodingString,
 IRubyObject internalEncoding,
 IRubyObject options)

set_encoding_by_bom

public IRubyObject set_encoding_by_bom(ThreadContext context)

setEncoding

public void setEncoding(ThreadContext context,
 IRubyObject v1,
 IRubyObject v2,
 IRubyObject opt)

open

public static IRubyObject open(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

ensureYieldClose

public static IRubyObject ensureYieldClose(ThreadContext context,
 IRubyObject port,
 Block block)

sysopen

@Deprecated
public static IRubyObject sysopen(IRubyObject recv,
 IRubyObject[] args,
 Block block)

Deprecated.

sysopen

public static IRubyObject sysopen(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] argv,
 Block block)

sysopen

protected static ChannelFD sysopen(Ruby runtime,
 String fname,
 int oflags,
 int perm)

cloexecOpen

public static ChannelFD cloexecOpen(Ruby runtime,
 RubyIO.Sysopen data)

isAutoclose

public boolean isAutoclose()

setAutoclose

public void setAutoclose(boolean autoclose)

autoclose

public IRubyObject autoclose(ThreadContext context)

autoclose_set

public IRubyObject autoclose_set(ThreadContext context,
 IRubyObject autoclose)

binmode

@Deprecated(since="10.0")
public IRubyObject binmode()

Deprecated.

Use binmode(ThreadContext) instead.

Returns:

binmode

public IRubyObject binmode(ThreadContext context)

op_binmode

public IRubyObject op_binmode(ThreadContext context)

syswrite

public IRubyObject syswrite(ThreadContext context,
 IRubyObject str)

write_nonblock

public IRubyObject write_nonblock(ThreadContext context,
 IRubyObject arg0)

write_nonblock

public IRubyObject write_nonblock(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

GetWriteIO

public RubyIO GetWriteIO()

write

public IRubyObject write(ThreadContext context,
 IRubyObject str)

Ruby method IO#write(str), equivalent to io_write_m.

Parameters:

context - the current context

str - the string to write

write2

public IRubyObject write2(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

Ruby method IO#write(str, ...), equivalent to io_write_m.

Parameters:

context - the current context

arg0 - the first string to write

arg1 - the second string to write

write3

public IRubyObject write3(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

Ruby method IO#write(str, ...), equivalent to io_write_m.

Parameters:

context - the current context

arg0 - the first string to write

arg1 - the second string to write

arg2 - the third string to write

write

public IRubyObject write(ThreadContext context,
 IRubyObject[] args)

Ruby method IO#write(str, ...), equivalent to io_write_m.

Parameters:

context - the current context

args - the strings to write

write

public final IRubyObject write(ThreadContext context,
 int ch)

Write a single byte to this IO's write target.

Parameters:

context - the current context

ch - the byte to write, as an int

Returns:

the count of bytes written

write

public final void write(ThreadContext context,
 byte ch)

Write a single byte to this IO's write target but do not return the number of bytes written (it will be 1). This version does not dig out any wrapped write IO (bytes will be written to this IO).

Parameters:

context - the current context

ch - the byte to write, as an int

write

public IRubyObject write(ThreadContext context,
 IRubyObject str,
 boolean nosync)

Write the given range of bytes to this IO's write target. Equivalent to io_write.

Parameters:

context - the current context

str - the string to write

nosync - whether to write without syncing

Returns:

the count of bytes written

write

public int write(ThreadContext context,
 byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding)

Write the given range of bytes to this IO. Equivalent to io_write_m with source bytes and no digging out any wrapped write IO (bytes will be written to this IO).

Parameters:

context - the current context

bytes - the bytes to write

start - start offset for writing

length - length to write

encoding - encoding of the bytes (will not be verified)

Returns:

the count of bytes written

write

public int write(ThreadContext context,
 byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding,
 boolean nosync)

Write the given range of bytes to this IO. Equivalent to io_write with source bytes and no digging out any wrapped write IO (bytes will be written to this IO.

Parameters:

context - the current context

bytes - the bytes to write

start - start offset for writing

length - length to write

encoding - encoding of the bytes (will not be verified)

nosync - whether to write without syncing

Returns:

the count of bytes written

write

public int write(byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding,
 boolean nosync)

Same as write(ThreadContext, byte[], int, int, Encoding, boolean) but context will be retrieved. Heavy use should retrieve context once and call the original method to avoid thread-local overhead.

Parameters:

bytes - the bytes to write

start - start offset for writing

length - length to write

encoding - encoding of the bytes (will not be verified)

nosync - whether to write without syncing

Returns:

the count of bytes written

write

public int write(byte[] bytes,
 int start,
 int length,
 org.jcodings.Encoding encoding)

Same as write(ThreadContext, byte[], int, int, Encoding, boolean) but context will be retrieved and nosync defaults to false. Heavy use should retrieve context once and call the original method to avoid thread-local overhead.

Parameters:

bytes - the bytes to write

start - start offset for writing

length - length to write

encoding - encoding of the bytes (will not be verified)

Returns:

the count of bytes written

write

public int write(byte[] bytes,
 org.jcodings.Encoding encoding)

Same as write(ThreadContext, byte[], int, int, Encoding, boolean) but context will be retrieved nosync defaults to false, and the entire byte array will be written. Heavy use should retrieve context once and call the original method to avoid thread-local overhead.

Parameters:

bytes - the bytes to write

encoding - encoding of the bytes (will not be verified)

Returns:

the count of bytes written

write

public void write(int bite)

Same as write(ThreadContext, byte) but context will be retrieved. Heavy use should retrieve context once and call the original method to avoid thread-local overhead.

Parameters:

bite - the byte to write, as an int

op_append

public IRubyObject op_append(ThreadContext context,
 IRubyObject anObject)

rb_io_addstr

fileno

public RubyFixnum fileno(ThreadContext context)

lineno

public RubyFixnum lineno(ThreadContext context)

Returns the current line number.

Returns:

the current line number.

lineno_set

public RubyFixnum lineno_set(ThreadContext context,
 IRubyObject newLineNumber)

Sets the current line number.

Parameters:

newLineNumber - The new line number.

sync

public RubyBoolean sync(ThreadContext context)

Returns the current sync mode. MRI: rb_io_sync

Returns:

the current sync mode.

pid

public IRubyObject pid(ThreadContext context)

Return the process id (pid) of the process this IO object spawned. If no process exists (popen was not called), then nil is returned. This is not how it appears to be defined but ruby 1.8 works this way.

Returns:

the pid or nil

pos

public RubyFixnum pos(ThreadContext context)

pos_set

public RubyFixnum pos_set(ThreadContext context,
 IRubyObject offset)

print

public IRubyObject print(ThreadContext context,
 IRubyObject[] args)

Print some objects to the stream.

print

public IRubyObject print(ThreadContext context)

print

public IRubyObject print(ThreadContext context,
 IRubyObject arg0)

print

public IRubyObject print(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

print

public IRubyObject print(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

print

public static IRubyObject print(ThreadContext context,
 IRubyObject out,
 IRubyObject[] args)

Print some objects to the stream. MRI: rb_io_print

print0

public static IRubyObject print0(ThreadContext context,
 IRubyObject out)

print1

public static IRubyObject print1(ThreadContext context,
 IRubyObject out,
 IRubyObject arg1)

print2

public static IRubyObject print2(ThreadContext context,
 IRubyObject out,
 IRubyObject arg0,
 IRubyObject arg1)

print3

public static IRubyObject print3(ThreadContext context,
 IRubyObject out,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

printf

public IRubyObject printf(ThreadContext context,
 IRubyObject[] args)

printf

public static IRubyObject printf(ThreadContext context,
 IRubyObject out,
 IRubyObject[] args)

putc

public IRubyObject putc(ThreadContext context,
 IRubyObject ch)

putc

public static IRubyObject putc(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject object)

seek

public RubyFixnum seek(ThreadContext context,
 IRubyObject[] args)

seek

public RubyFixnum seek(ThreadContext context,
 IRubyObject off)

seek

public RubyFixnum seek(ThreadContext context,
 IRubyObject off,
 IRubyObject whence)

sysseek

public RubyFixnum sysseek(ThreadContext context,
 IRubyObject[] args)

rewind

public RubyFixnum rewind(ThreadContext context)

fsync

public RubyFixnum fsync(ThreadContext context)

sync_set

@Deprecated(since="10.0")
public IRubyObject sync_set(IRubyObject sync)

Deprecated.

Use sync_set(ThreadContext, IRubyObject) instead.

Parameters:

sync -

Returns:

sync_set

public IRubyObject sync_set(ThreadContext context,
 IRubyObject sync)

Sets the current sync mode. MRI: rb_io_set_sync

Parameters:

sync - The new sync mode.

setSync

public void setSync(boolean sync)

getSync

public boolean getSync()

eof_p

public RubyBoolean eof_p(ThreadContext context)

tty_p

public RubyBoolean tty_p(ThreadContext context)

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject _io)

Description copied from class: RubyBasicObject

Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different.

Overrides:

initialize_copy in class RubyBasicObject

Parameters:

context - the thread context

_io - the original

Returns:

a copy unless the same thing

closed_p

public RubyBoolean closed_p(ThreadContext context)

isClosed

public boolean isClosed()

Is this IO closed MRI: rb_io_closed

Returns:

true if closed

close

public IRubyObject close(ThreadContext context)

Closes all open resources for the IO. It also removes it from our magical all open file descriptor pool.

Returns:

The IO. Returns nil if the IO was already closed. MRI: rb_io_close_m

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

ioClose

protected static IRubyObject ioClose(ThreadContext context,
 IRubyObject io)

rbIoClose

protected IRubyObject rbIoClose(ThreadContext context)

close_write

public IRubyObject close_write(ThreadContext context)

close_read

public IRubyObject close_read(ThreadContext context)

close_on_exec_set

public IRubyObject close_on_exec_set(ThreadContext context,
 IRubyObject arg)

close_on_exec_p

public IRubyObject close_on_exec_p(ThreadContext context)

flush

public RubyIO flush(ThreadContext context)

Flushes the IO output stream. MRI: rb_io_flush

Returns:

The IO.

flush

public void flush()

Specified by:

flush in interface Flushable

flushRaw

protected RubyIO flushRaw(ThreadContext context,
 boolean sync)

gets

public IRubyObject gets(ThreadContext context)

Read a line.

gets

public IRubyObject gets(ThreadContext context,
 IRubyObject arg)

gets

public IRubyObject gets(ThreadContext context,
 IRubyObject rs,
 IRubyObject limit_arg)

gets

public IRubyObject gets(ThreadContext context,
 IRubyObject rs,
 IRubyObject limit_arg,
 IRubyObject opt)

getBlocking

public boolean getBlocking()

setBlocking

public void setBlocking(boolean blocking)

fcntl

public IRubyObject fcntl(ThreadContext context,
 IRubyObject cmd)

fcntl

public IRubyObject fcntl(ThreadContext context,
 IRubyObject cmd,
 IRubyObject arg)

ioctl

public IRubyObject ioctl(ThreadContext context,
 IRubyObject[] args)

puts

public IRubyObject puts(ThreadContext context)

puts

public IRubyObject puts(ThreadContext context,
 IRubyObject arg0)

puts

public IRubyObject puts(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

puts

public IRubyObject puts(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

puts

public IRubyObject puts(ThreadContext context,
 IRubyObject[] args)

puts0

public static IRubyObject puts0(ThreadContext context,
 IRubyObject maybeIO)

puts1

public static IRubyObject puts1(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject arg0)

puts2

public static IRubyObject puts2(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject arg0,
 IRubyObject arg1)

puts3

public static IRubyObject puts3(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

puts

public static IRubyObject puts(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject... args)

write

protected static IRubyObject write(ThreadContext context,
 IRubyObject maybeIO,
 ByteList byteList)

write

protected static IRubyObject write(ThreadContext context,
 IRubyObject maybeIO,
 ByteList byteList,
 IRubyObject sep)

write

public static IRubyObject write(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject str)

write

public static IRubyObject write(ThreadContext context,
 IRubyObject maybeIO,
 IRubyObject arg0,
 IRubyObject arg1)

writev

public static IRubyObject writev(ThreadContext context,
 IRubyObject io,
 IRubyObject[] args)

writev

public static IRubyObject writev(ThreadContext context,
 IRubyObject io)

writev

public static IRubyObject writev(ThreadContext context,
 IRubyObject io,
 IRubyObject arg0)

writev

public static IRubyObject writev(ThreadContext context,
 IRubyObject io,
 IRubyObject arg0,
 IRubyObject arg1)

writev

public static IRubyObject writev(ThreadContext context,
 IRubyObject io,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

inspect

public IRubyObject inspect(ThreadContext context)

Description copied from class: RubyBasicObject

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

readline

public IRubyObject readline(ThreadContext context)

Read a line.

readline

public IRubyObject readline(ThreadContext context,
 IRubyObject separator)

readline

public IRubyObject readline(ThreadContext context,
 IRubyObject separator,
 IRubyObject limit)

readline

public IRubyObject readline(ThreadContext context,
 IRubyObject separator,
 IRubyObject limit,
 IRubyObject opts)

getc

@Deprecated
public IRubyObject getc()

Deprecated.

readchar

public IRubyObject readchar(ThreadContext context)

Read a char. On EOF throw EOFError.

getbyte

public IRubyObject getbyte(ThreadContext context)

Read a byte. On EOF returns nil.

getByte

public int getByte(ThreadContext context)

readbyte

public IRubyObject readbyte(ThreadContext context)

getc

public IRubyObject getc(ThreadContext context)

ungetbyte

public IRubyObject ungetbyte(ThreadContext context,
 IRubyObject b)

ungetc

public IRubyObject ungetc(ThreadContext context,
 IRubyObject c)

read_nonblock

public IRubyObject read_nonblock(ThreadContext context,
 IRubyObject arg0)

read_nonblock

public IRubyObject read_nonblock(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

read_nonblock

public IRubyObject read_nonblock(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

doReadNonblock

public IRubyObject doReadNonblock(ThreadContext context,
 IRubyObject arg0,
 boolean exception)

doReadNonblock

public IRubyObject doReadNonblock(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 boolean exception)

doReadNonblock

public IRubyObject doReadNonblock(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 boolean exception)

doReadNonblock

public IRubyObject doReadNonblock(ThreadContext context,
 IRubyObject[] args,
 boolean exception)

readpartial

public IRubyObject readpartial(ThreadContext context,
 IRubyObject arg0)

readpartial

public IRubyObject readpartial(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

sysread

public IRubyObject sysread(ThreadContext context,
 IRubyObject _length)

sysread

public IRubyObject sysread(ThreadContext context,
 IRubyObject _length,
 IRubyObject _str)

read

@Deprecated(since="10.0")
public IRubyObject read(IRubyObject[] args)

Deprecated.

read

public IRubyObject read(ThreadContext context,
 IRubyObject[] args)

read

public IRubyObject read(ThreadContext context)

Read all available bytes. Equivalent to io_read with no arguments.

Parameters:

context - the current context

Returns:

the output buffer viewing the actual range of bytes read

read

public IRubyObject read(ThreadContext context,
 IRubyObject length)

Read length bytes. Equivalent to io_read with a length argument.

Parameters:

context - the current context

length - a numeric value of the count of bytes to read

Returns:

the output buffer viewing the actual range of bytes read

read

public IRubyObject read(ThreadContext context,
 IRubyObject length,
 IRubyObject maybeStr)

Read into the given buffer (or create a new one) reading length bytes. Equivalent to io_read.

Parameters:

context - the current context

length - a numeric value of the count of bytes to read

maybeStr - a RubyString buffer or a nil to indicate a new buffer should be created

Returns:

the output buffer viewing the actual range of bytes read

checkLength

protected void checkLength(ThreadContext context,
 int len)

read

public int read(ThreadContext context,
 byte[] buffer,
 int start,
 int len)

Read into the given buffer starting from start and reading len bytes. Equivalent to io_read with target byte[] buffer already in hand.

Parameters:

context - the current context

buffer - the target buffer

start - start offset in target buffer

len - count of bytes to read

Returns:

the number of bytes actually read or -1 for EOF

doRead

protected static int doRead(ThreadContext context,
 OpenFile fptr,
 byte[] buffer,
 int start,
 int len)

readchar

@Deprecated
public IRubyObject readchar()

Deprecated.

stat

public IRubyObject stat(ThreadContext context)

each_byteInternal

public IRubyObject each_byteInternal(ThreadContext context,
 Block block)

Invoke a block for each byte.

MRI: rb_io_each_byte

each_byte

public IRubyObject each_byte(ThreadContext context,
 Block block)

bytes

@Deprecated(since="10.0")
public IRubyObject bytes(ThreadContext context,
 Block block)

Deprecated.

each_charInternal

public IRubyObject each_charInternal(ThreadContext context,
 Block block)

each_char

public IRubyObject each_char(ThreadContext context,
 Block block)

chars

@Deprecated(since="10.0")
public IRubyObject chars(ThreadContext context,
 Block block)

Deprecated.

codepoints

@Deprecated(since="10.0")
public IRubyObject codepoints(ThreadContext context,
 Block block)

Deprecated.

each_codepoint

public IRubyObject each_codepoint(ThreadContext context,
 Block block)

each

public IRubyObject each(ThreadContext context,
 Block block)

each

public IRubyObject each(ThreadContext context,
 IRubyObject arg0,
 Block block)

each

public IRubyObject each(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

each

public IRubyObject each(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

each

public IRubyObject each(ThreadContext context,
 IRubyObject[] args,
 Block block)

each_line

public IRubyObject each_line(ThreadContext context,
 Block block)

each_line

public IRubyObject each_line(ThreadContext context,
 IRubyObject arg0,
 Block block)

each_line

public IRubyObject each_line(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

each_line

public IRubyObject each_line(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

each_line

public IRubyObject each_line(ThreadContext context,
 IRubyObject[] args,
 Block block)

lines

@Deprecated(since="10.0")
public IRubyObject lines(ThreadContext context,
 Block block)

Deprecated.

readlines

public RubyArray readlines(ThreadContext context)

readlines

public RubyArray readlines(ThreadContext context,
 IRubyObject arg0)

readlines

public RubyArray readlines(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

readlines

public RubyArray readlines(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

readlines

public RubyArray readlines(ThreadContext context,
 IRubyObject[] args)

to_io

public RubyIO to_io()

toString

public String toString()

Description copied from class: RubyObject

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Overrides:

toString in class RubyObject

Returns:

string representation

foreach

public static IRubyObject foreach(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

convertToIO

public static RubyIO convertToIO(ThreadContext context,
 IRubyObject obj)

select

public static IRubyObject select(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] argv)

wait_readable

public IRubyObject wait_readable(ThreadContext context,
 IRubyObject[] argv)

wait_writable

public IRubyObject wait_writable(ThreadContext context,
 IRubyObject[] argv)

waits until input available or timed out and returns self, or nil when EOF reached.

wait

public IRubyObject wait(ThreadContext context,
 IRubyObject[] argv)

advise

public IRubyObject advise(ThreadContext context,
 IRubyObject[] argv)

failIfDirectory

public static void failIfDirectory(Ruby runtime,
 RubyString pathStr)

ioOpen

public static IRubyObject ioOpen(ThreadContext context,
 IRubyObject recv,
 IRubyObject filename,
 IRubyObject vmode,
 IRubyObject vperm,
 IRubyObject opt)

binread

public static IRubyObject binread(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

binread is just like read, except it doesn't take options and it forces mode to be "rb:ASCII-8BIT"

Parameters:

context - the current ThreadContext

recv - the target of the call (IO or a subclass)

args - arguments; path [, length [, offset]]

Returns:

the binary contents of the given file, at specified length and offset

read

public static IRubyObject read(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block unusedBlock)

read

public static IRubyObject read(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

binwrite

public static IRubyObject binwrite(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

write

public static IRubyObject write(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] argv)

ioStaticWrite

public static IRubyObject ioStaticWrite(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] argv,
 boolean binary)

readlines

public static IRubyObject readlines(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block unusedBlock)

popen

public static IRubyObject popen(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

pipe

public static IRubyObject pipe(ThreadContext context,
 IRubyObject recv)

pipe

public static IRubyObject pipe(ThreadContext context,
 IRubyObject klass,
 Block block)

pipe

public static IRubyObject pipe(ThreadContext context,
 IRubyObject klass,
 IRubyObject arg0,
 Block block)

pipe

public static IRubyObject pipe(ThreadContext context,
 IRubyObject klass,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

pipe

public static IRubyObject pipe(ThreadContext context,
 IRubyObject klass,
 IRubyObject v1,
 IRubyObject v2,
 IRubyObject opt,
 Block block)

ensureYieldClosePipes

public static IRubyObject ensureYieldClosePipes(ThreadContext context,
 IRubyObject obj,
 RubyIO r,
 RubyIO w,
 Block block)

copy_stream

public static IRubyObject copy_stream(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg0,
 IRubyObject arg1)

copy_stream

public static IRubyObject copy_stream(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

copy_stream

public static IRubyObject copy_stream(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

tryConvert

public static IRubyObject tryConvert(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg)

pread

public IRubyObject pread(ThreadContext context,
 IRubyObject len,
 IRubyObject offset)

pread

public IRubyObject pread(ThreadContext context,
 IRubyObject _length,
 IRubyObject _from,
 IRubyObject str)

pwrite

public IRubyObject pwrite(ThreadContext context,
 IRubyObject str,
 IRubyObject offset)

wait_readable

public static IRubyObject wait_readable(ThreadContext context,
 IRubyObject _io,
 IRubyObject[] argv)

wait_writable

public static IRubyObject wait_writable(ThreadContext context,
 IRubyObject _io,
 IRubyObject[] argv)

waits until input available or timed out and returns self, or nil when EOF reached.

wait

public static IRubyObject wait(ThreadContext context,
 IRubyObject _io,
 IRubyObject[] argv)

path

public IRubyObject path(ThreadContext context)

getPath

public String getPath()

setPath

protected void setPath(String path)

addBlockingThread

public void addBlockingThread(RubyThread thread)

Add a thread to the list of blocking threads for this IO.

Parameters:

thread - A thread blocking on this IO

removeBlockingThread

public void removeBlockingThread(RubyThread thread)

Remove a thread from the list of blocking threads for this IO.

Parameters:

thread - A thread blocking on this IO

updateIOOptionsFromOptions

protected IOOptions updateIOOptionsFromOptions(ThreadContext context,
 RubyHash options,
 IOOptions ioOptions)

See http://ruby-doc.org/core-1.9.3/IO.html#method-c-new for the format of modes in options

checkExecOptions

@Deprecated
public static void checkExecOptions(IRubyObject options)

Deprecated.

checkSpawnOptions

@Deprecated
public static void checkSpawnOptions(IRubyObject options)

Deprecated.

checkPopenOptions

@Deprecated
public static void checkPopenOptions(IRubyObject options)

Deprecated.

obliterateProcess

public static void obliterateProcess(Process process)

Try for around 1s to destroy the child process. This is to work around issues on some JVMs where if you try to destroy the process too quickly it may not be ready and may ignore the destroy. A subsequent waitFor will then hang. This version tries to destroy and call exitValue repeatedly for up to 1000 calls with 1ms delay between iterations, with the intent that the target process ought to be "ready to die" fairly quickly and we don't get stuck in a blocking waitFor call.

Parameters:

process - The process to obliterate

newModeFlags

public static ModeFlags newModeFlags(Ruby runtime,
 long mode)

newModeFlags

public static ModeFlags newModeFlags(Ruby runtime,
 int mode)

newModeFlags

public static ModeFlags newModeFlags(Ruby runtime,
 String mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
 ModeFlags modeFlags)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
 long mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
 int mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
 String mode)

newIOOptions

public static IOOptions newIOOptions(Ruby runtime,
 IOOptions oldFlags,
 int orOflags)

readline

@Deprecated
public IRubyObject readline(ThreadContext context,
 IRubyObject[] args)

Deprecated.

setEnc2

public void setEnc2(org.jcodings.Encoding enc2)

Specified by:

setEnc2 in interface IOEncodable

setEnc

public void setEnc(org.jcodings.Encoding enc)

Specified by:

setEnc in interface IOEncodable

setEcflags

public void setEcflags(int ecflags)

Specified by:

setEcflags in interface IOEncodable

getEcflags

public int getEcflags()

Specified by:

getEcflags in interface IOEncodable

setEcopts

public void setEcopts(IRubyObject ecopts)

Specified by:

setEcopts in interface IOEncodable

getEcopts

public IRubyObject getEcopts()

Specified by:

getEcopts in interface IOEncodable

setBOM

public void setBOM(boolean bom)

Specified by:

setBOM in interface IOEncodable

getBOM

public boolean getBOM()

Specified by:

getBOM in interface IOEncodable

toJava

public <T> T toJava(Class<T> target)

Description copied from interface: IRubyObject

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyBasicObject

Type Parameters:

T - type

Parameters:

target - The target type to which the object should be converted.

Returns:

java type

See Also:

• IRubyObject.toJava(java.lang.Class<T>)

setAscii8bitBinmode

protected RubyIO setAscii8bitBinmode()

MakeOpenFile

public final OpenFile MakeOpenFile()

getline

@Deprecated
public IRubyObject getline(Ruby runtime,
 ByteList separator)

Deprecated.

getline

@Deprecated
public IRubyObject getline(Ruby runtime,
 ByteList separator,
 long limit)

Deprecated.

getline

@Deprecated
public IRubyObject getline(ThreadContext context,
 ByteList separator)

Deprecated.

getline

@Deprecated
public IRubyObject getline(ThreadContext context,
 ByteList separator,
 long limit)

Deprecated.

getIOModes

@Deprecated
public static ModeFlags getIOModes(Ruby runtime,
 String modesString)

Deprecated.

getIOModesIntFromString

@Deprecated
public static int getIOModesIntFromString(Ruby runtime,
 String modesString)

Deprecated.

writeStatic

@Deprecated
public static IRubyObject writeStatic(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] argv,
 Block unusedBlock)

Deprecated.

popen3

@Deprecated
public static IRubyObject popen3(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

Deprecated.

popen4

@Deprecated
public static IRubyObject popen4(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

Deprecated.

popenSpecial

@Deprecated
public static org.jruby.RubyIO.POpenTuple popenSpecial(ThreadContext context,
 IRubyObject[] args)

Deprecated.

doWriteNonblock

@Deprecated
public IRubyObject doWriteNonblock(ThreadContext context,
 IRubyObject[] argv,
 boolean useException)

Deprecated.

select_static

@Deprecated
public static IRubyObject select_static(ThreadContext context,
 Ruby runtime,
 IRubyObject[] args)

Deprecated.

checkExecEnv

@Deprecated
public static RubyArray checkExecEnv(ThreadContext context,
 RubyHash hash)

Deprecated.

ioOpen

@Deprecated
public static IRubyObject ioOpen(ThreadContext context,
 IRubyObject filename,
 IRubyObject vmode,
 IRubyObject vperm,
 IRubyObject opt)

Deprecated.

write_nonblock

@Deprecated
public IRubyObject write_nonblock(ThreadContext context,
 IRubyObject[] argv)

Deprecated.

read_nonblock

@Deprecated
public IRubyObject read_nonblock(ThreadContext context,
 IRubyObject[] args)

Deprecated.

readpartial

@Deprecated
public IRubyObject readpartial(ThreadContext context,
 IRubyObject[] args)

Deprecated.

sysread

@Deprecated
public IRubyObject sysread(ThreadContext context,
 IRubyObject[] args)

Deprecated.

pipe

@Deprecated
public static IRubyObject pipe(ThreadContext context,
 IRubyObject klass,
 IRubyObject[] argv,
 Block block)

Deprecated.