Package org.jruby.runtime.marshal

Class MarshalStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.jruby.runtime.marshal.MarshalStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class MarshalStream
extends FilterOutputStream

Marshals objects into Ruby's binary marshal format.

Field Summary

Fields

Modifier and Type	Field	Description
private final MarshalCache	cache
private int	depth
private final int	depthLimit
private final Ruby	runtime
private static final String	SYMBOL_ENCODING
static final String	SYMBOL_ENCODING_SPECIAL
private boolean	tainted
private static final char	TYPE_IVAR
private static final char	TYPE_UCLASS
private static final char	TYPE_USERDEF
private static final char	TYPE_USRMARSHAL

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
MarshalStream(Ruby runtime, OutputStream out, int depthLimit)

Method Summary

Modifier and Type	Method	Description
void	dumpDefaultObjectHeader(char tp, RubyClass type)
void	dumpDefaultObjectHeader(RubyClass type)
private RubyClass	dumpExtended(RubyClass type)	w_extended
void	dumpObject(IRubyObject value)
void	dumpSymbol(ByteList value)
void	dumpVariables(List<Variable<Object>> vars)
private void	dumpVariablesShared(List<Variable<Object>> vars)
void	dumpVariablesWithEncoding(List<Variable<Object>> vars, IRubyObject obj)
static String	getPathFromClass(RubyModule clazz)
private List<Variable<Object>>	getVariables(IRubyObject value)
private boolean	hasSingletonMethods(RubyClass type)
private static boolean	isMarshalFixnum(RubyFixnum fixnum)
boolean	isTainted()
boolean	isUntrusted()	Deprecated.
void	registerLinkTarget(IRubyObject newObject)
void	registerSymbol(ByteList sym)
(package private) static boolean	shouldBeRegistered(IRubyObject value)
private static boolean	shouldMarshalEncoding(IRubyObject value)
private void	userCommon(IRubyObject value, CacheEntry entry)
void	userMarshal(IRubyObject value)
void	userMarshal(IRubyObject value, CacheEntry entry)
private void	userNewCommon(IRubyObject value, CacheEntry entry)
void	userNewMarshal(IRubyObject value)
void	userNewMarshal(IRubyObject value, CacheEntry entry)
private void	writeAndRegister(IRubyObject value)
private void	writeAndRegisterSymbol(ByteList sym)
void	writeByte(int value)
void	writeDirectly(IRubyObject value)
void	writeEncoding(org.jcodings.Encoding encoding)
void	writeInt(int value)
private void	writeObjectData(IRubyObject value)
void	writeString(String value)
void	writeString(ByteList value)
void	writeUserClass(IRubyObject obj, RubyClass type)

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

runtime

private final Ruby runtime

cache

private final MarshalCache cache

depthLimit

private final int depthLimit

tainted

private boolean tainted

depth

private int depth

TYPE_IVAR

private static final char TYPE_IVAR

See Also:

• Constant Field Values

TYPE_USRMARSHAL

private static final char TYPE_USRMARSHAL

See Also:

• Constant Field Values

TYPE_USERDEF

private static final char TYPE_USERDEF

See Also:

• Constant Field Values

TYPE_UCLASS

private static final char TYPE_UCLASS

See Also:

• Constant Field Values

SYMBOL_ENCODING_SPECIAL

public static final String SYMBOL_ENCODING_SPECIAL

See Also:

• Constant Field Values

SYMBOL_ENCODING

private static final String SYMBOL_ENCODING

See Also:

• Constant Field Values

Constructor Details

MarshalStream

public MarshalStream(Ruby runtime,
 OutputStream out,
 int depthLimit)
              throws IOException

Throws:

IOException

Method Details

dumpObject

public void dumpObject(IRubyObject value)
                throws IOException

Throws:

IOException

registerLinkTarget

public void registerLinkTarget(IRubyObject newObject)

registerSymbol

public void registerSymbol(ByteList sym)

shouldBeRegistered

static boolean shouldBeRegistered(IRubyObject value)

isMarshalFixnum

private static boolean isMarshalFixnum(RubyFixnum fixnum)

writeAndRegisterSymbol

private void writeAndRegisterSymbol(ByteList sym)
                             throws IOException

Throws:

IOException

writeAndRegister

private void writeAndRegister(IRubyObject value)
                       throws IOException

Throws:

IOException

getVariables

private List<Variable<Object>> getVariables(IRubyObject value)
                                     throws IOException

Throws:

IOException

shouldMarshalEncoding

private static boolean shouldMarshalEncoding(IRubyObject value)

writeDirectly

public void writeDirectly(IRubyObject value)
                   throws IOException

Throws:

IOException

getPathFromClass

public static String getPathFromClass(RubyModule clazz)

writeObjectData

private void writeObjectData(IRubyObject value)
                      throws IOException

Throws:

IOException

userNewMarshal

public void userNewMarshal(IRubyObject value,
 CacheEntry entry)
                    throws IOException

Throws:

IOException

userNewMarshal

public void userNewMarshal(IRubyObject value)
                    throws IOException

Throws:

IOException

userNewCommon

private void userNewCommon(IRubyObject value,
 CacheEntry entry)
                    throws IOException

Throws:

IOException

userMarshal

public void userMarshal(IRubyObject value,
 CacheEntry entry)
                 throws IOException

Throws:

IOException

userMarshal

public void userMarshal(IRubyObject value)
                 throws IOException

Throws:

IOException

userCommon

private void userCommon(IRubyObject value,
 CacheEntry entry)
                 throws IOException

Throws:

IOException

writeUserClass

public void writeUserClass(IRubyObject obj,
 RubyClass type)
                    throws IOException

Throws:

IOException

dumpVariablesWithEncoding

public void dumpVariablesWithEncoding(List<Variable<Object>> vars,
 IRubyObject obj)
                               throws IOException

Throws:

IOException

dumpVariables

public void dumpVariables(List<Variable<Object>> vars)
                   throws IOException

Throws:

IOException

dumpVariablesShared

private void dumpVariablesShared(List<Variable<Object>> vars)
                          throws IOException

Throws:

IOException

writeEncoding

public void writeEncoding(org.jcodings.Encoding encoding)
                   throws IOException

Throws:

IOException

hasSingletonMethods

private boolean hasSingletonMethods(RubyClass type)

dumpExtended

private RubyClass dumpExtended(RubyClass type)
                        throws IOException

w_extended

Throws:

IOException

dumpDefaultObjectHeader

public void dumpDefaultObjectHeader(RubyClass type)
                             throws IOException

Throws:

IOException

dumpDefaultObjectHeader

public void dumpDefaultObjectHeader(char tp,
 RubyClass type)
                             throws IOException

Throws:

IOException

writeString

public void writeString(String value)
                 throws IOException

Throws:

IOException

writeString

public void writeString(ByteList value)
                 throws IOException

Throws:

IOException

dumpSymbol

public void dumpSymbol(ByteList value)
                throws IOException

Throws:

IOException

writeInt

public void writeInt(int value)
              throws IOException

Throws:

IOException

writeByte

public void writeByte(int value)
               throws IOException

Throws:

IOException

isTainted

public boolean isTainted()

isUntrusted

@Deprecated
public boolean isUntrusted()

Deprecated.