Show / Hide Table of Contents

Class ErlInputStream

Provides a stream for decoding Erlang terms from external format

Inheritance
System.Object
System.MarshalByRefObject
System.IO.Stream
ErlInputStream
Implements
System.IDisposable
Inherited Members
System.IO.Stream.Null
System.IO.Stream.BeginRead(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)
System.IO.Stream.BeginWrite(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)
System.IO.Stream.Close()
System.IO.Stream.CopyTo(System.IO.Stream)
System.IO.Stream.CopyTo(System.IO.Stream, System.Int32)
System.IO.Stream.CopyToAsync(System.IO.Stream)
System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32)
System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32, System.Threading.CancellationToken)
System.IO.Stream.CreateWaitHandle()
System.IO.Stream.Dispose()
System.IO.Stream.Dispose(System.Boolean)
System.IO.Stream.EndRead(System.IAsyncResult)
System.IO.Stream.EndWrite(System.IAsyncResult)
System.IO.Stream.FlushAsync()
System.IO.Stream.FlushAsync(System.Threading.CancellationToken)
System.IO.Stream.ObjectInvariant()
System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32)
System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)
System.IO.Stream.Synchronized(System.IO.Stream)
System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32)
System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)
System.IO.Stream.WriteByte(System.Byte)
System.IO.Stream.CanTimeout
System.IO.Stream.ReadTimeout
System.IO.Stream.WriteTimeout
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NFX.Erlang
Assembly: NFX.Erlang.dll
Syntax
public class ErlInputStream : Stream, IDisposable

Constructors

ErlInputStream(Byte[], Boolean, Encoding)

Declaration
public ErlInputStream(byte[] buf, bool checkVersion = true, Encoding encoding = null)
Parameters
Type Name Description
System.Byte[] buf
System.Boolean checkVersion
System.Text.Encoding encoding

ErlInputStream(Byte[], Int32, Int32, Boolean, Encoding)

Declaration
public ErlInputStream(byte[] buf, int offset, int length, bool checkVersion = true, Encoding encoding = null)
Parameters
Type Name Description
System.Byte[] buf
System.Int32 offset
System.Int32 length
System.Boolean checkVersion
System.Text.Encoding encoding

Properties

CanRead

Declaration
public override bool CanRead { get; }
Property Value
Type Description
System.Boolean
Overrides
System.IO.Stream.CanRead

CanSeek

Declaration
public override bool CanSeek { get; }
Property Value
Type Description
System.Boolean
Overrides
System.IO.Stream.CanSeek

CanWrite

Declaration
public override bool CanWrite { get; }
Property Value
Type Description
System.Boolean
Overrides
System.IO.Stream.CanWrite

Length

Declaration
public override long Length { get; }
Property Value
Type Description
System.Int64
Overrides
System.IO.Stream.Length

Position

Declaration
public override long Position { get; set; }
Property Value
Type Description
System.Int64
Overrides
System.IO.Stream.Position

Methods

Flush()

Declaration
public override void Flush()
Overrides
System.IO.Stream.Flush()

Read()

Read arbitraty Erlang term from the stream

Declaration
public IErlObject Read()
Returns
Type Description
IErlObject

Read(Boolean)

Read arbitraty Erlang term from the stream, optionally checking protocol version byte

Declaration
public IErlObject Read(bool checkVersion)
Parameters
Type Name Description
System.Boolean checkVersion
Returns
Type Description
IErlObject

Read(Byte[], Int32, Int32)

Declaration
public override int Read(byte[] buffer, int offset, int count)
Parameters
Type Name Description
System.Byte[] buffer
System.Int32 offset
System.Int32 count
Returns
Type Description
System.Int32
Overrides
System.IO.Stream.Read(System.Byte[], System.Int32, System.Int32)

ReadAtom()

Read an Erlang atom from the stream

Declaration
public ErlAtom ReadAtom()
Returns
Type Description
ErlAtom

ReadAtomOrBool()

Declaration
public IErlObject ReadAtomOrBool()
Returns
Type Description
IErlObject

ReadBinary()

Read an Erlang binary from the stream

Declaration
public ErlBinary ReadBinary()
Returns
Type Description
ErlBinary

ReadBoolean()

Read an Erlang atom from the stream and interpret the value as a boolean

Declaration
public ErlBoolean ReadBoolean()
Returns
Type Description
ErlBoolean

ReadByte()

Read an Erlang byte from the stream

Declaration
public ErlByte ReadByte()
Returns
Type Description
ErlByte

ReadByteOrLong()

Declaration
public IErlObject ReadByteOrLong()
Returns
Type Description
IErlObject

ReadDouble()

Read an Erlang float from the stream

Declaration
public ErlDouble ReadDouble()
Returns
Type Description
ErlDouble

ReadList()

Read Erlang list from the stream

Declaration
public ErlList ReadList()
Returns
Type Description
ErlList

ReadLong()

Declaration
public ErlLong ReadLong()
Returns
Type Description
ErlLong

ReadMap()

Declaration
public ErlMap ReadMap()
Returns
Type Description
ErlMap

ReadPid()

Read Erlang pid from the stream

Declaration
public ErlPid ReadPid()
Returns
Type Description
ErlPid

ReadPort()

Read Erlang port from the stream

Declaration
public ErlPort ReadPort()
Returns
Type Description
ErlPort

ReadRef()

Read Erlang reference from the stream

Declaration
public ErlRef ReadRef()
Returns
Type Description
ErlRef

ReadString()

Read Erlang string or list from the stream

Declaration
public ErlString ReadString()
Returns
Type Description
ErlString

ReadTuple()

Read Erlang tuple from the stream

Declaration
public ErlTuple ReadTuple()
Returns
Type Description
ErlTuple

Seek(Int64, SeekOrigin)

Declaration
public override long Seek(long offset, SeekOrigin origin)
Parameters
Type Name Description
System.Int64 offset
System.IO.SeekOrigin origin
Returns
Type Description
System.Int64
Overrides
System.IO.Stream.Seek(System.Int64, System.IO.SeekOrigin)

SetLength(Int64)

Declaration
public override void SetLength(long value)
Parameters
Type Name Description
System.Int64 value
Overrides
System.IO.Stream.SetLength(System.Int64)

ToBinaryString(Int32, Int32, Int32)

Declaration
public string ToBinaryString(int offset = 0, int count = -1, int maxLen = 0)
Parameters
Type Name Description
System.Int32 offset
System.Int32 count
System.Int32 maxLen
Returns
Type Description
System.String

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Write(Byte[], Int32, Int32)

Declaration
public override void Write(byte[] buffer, int offset, int count)
Parameters
Type Name Description
System.Byte[] buffer
System.Int32 offset
System.Int32 count
Overrides
System.IO.Stream.Write(System.Byte[], System.Int32, System.Int32)

Implements

System.IDisposable

Extension Methods

IOMiscUtils.ReadBEShort(Stream)
IOMiscUtils.ReadLEShort(Stream)
IOMiscUtils.ReadBEUShort(Stream)
IOMiscUtils.ReadLEUShort(Stream)
IOMiscUtils.ReadBEInt32(Stream)
IOMiscUtils.ReadLEInt32(Stream)
IOMiscUtils.ReadBEUInt64(Stream)
IOMiscUtils.ReadLEUInt64(Stream)
IOMiscUtils.WriteBEShort(Stream, Int16)
IOMiscUtils.WriteLEShort(Stream, Int16)
IOMiscUtils.WriteBEUShort(Stream, UInt16)
IOMiscUtils.WriteLEUShort(Stream, UInt16)
IOMiscUtils.WriteBEInt32(Stream, Int32)
IOMiscUtils.WriteLEInt32(Stream, Int32)
IOMiscUtils.WriteBEUInt64(Stream, UInt64)
IOMiscUtils.WriteLEUInt64(Stream, UInt64)
IOMiscUtils.AsCharEnumerable(Stream)
MiscUtils.NonNull<T>(T, Func<Exception>, String)
ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
LEB128.WriteSLEB128(Stream, Int64, Int32)
LEB128.WriteSLEB128(Stream, Int64, out Int32, Int32)
LEB128.WriteULEB128(Stream, UInt64, UInt32)
LEB128.WriteULEB128(Stream, UInt64, out Int32, UInt32)
LEB128.ReadSLEB128(Stream)
LEB128.ReadSLEB128(Stream, out Int32)
LEB128.ReadULEB128(Stream)
LEB128.ReadULEB128(Stream, out Int32)
JSONExtensions.JSONToDynamic(Stream, Encoding, Boolean)
JSONExtensions.JSONToDataObject(Stream, Encoding, Boolean)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX