Struct ErlRef

Provides a C# representation of Erlang integer types

Implements
System.IComparable
System.IComparable<IErlObject>
System.IEquatable<IErlObject>
System.ICloneable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NFX.Erlang
Assembly: NFX.Erlang.dll
Syntax
public struct ErlRef : IErlObject<ErlRef>, IErlObject, IComparable, IComparable<IErlObject>, IEquatable<IErlObject>, ICloneable

Constructors

ErlRef(ErlAtom, Int32, Int32, Int32, Int32)

Declaration
public ErlRef(ErlAtom node, int id1, int id2, int id3, int creation)
Parameters
Type Name Description
ErlAtom node
System.Int32 id1
System.Int32 id2
System.Int32 id3
System.Int32 creation

ErlRef(ErlAtom, Int32[], Int32)

Create an Erlang reference from the given values

Declaration
public ErlRef(ErlAtom node, int[] ids, int creation)
Parameters
Type Name Description
ErlAtom node
System.Int32[] ids
System.Int32 creation

ErlRef(ErlAtom, UInt32[], Int32)

Create an Erlang reference from the given values

Declaration
public ErlRef(ErlAtom node, uint[] ids, int creation)
Parameters
Type Name Description
ErlAtom node
System.UInt32[] ids
System.Int32 creation

ErlRef(String, Int32, Int32, Int32, Int32)

Declaration
public ErlRef(string node, int id1, int id2, int id3, int creation)
Parameters
Type Name Description
System.String node
System.Int32 id1
System.Int32 id2
System.Int32 id3
System.Int32 creation

ErlRef(String, Int32[], Int32)

Create an Erlang reference from the given values

Declaration
public ErlRef(string node, int[] ids, int creation)
Parameters
Type Name Description
System.String node
System.Int32[] ids
System.Int32 creation

Fields

Creation

Declaration
public readonly int Creation
Field Value
Type Description
System.Int32

Ids

Declaration
public readonly uint[] Ids
Field Value
Type Description
System.UInt32[]

Node

Declaration
public readonly ErlAtom Node
Field Value
Type Description
ErlAtom

Null

Special value non-existing Pid used for "null" ref comparison

Declaration
public static readonly ErlRef Null
Field Value
Type Description
ErlRef

Properties

Empty

Declaration
public bool Empty { get; }
Property Value
Type Description
System.Boolean

IsScalar

Declaration
public bool IsScalar { get; }
Property Value
Type Description
System.Boolean

TypeOrder

Declaration
public ErlTypeOrder TypeOrder { get; }
Property Value
Type Description
ErlTypeOrder

Value

Declaration
public ErlRef Value { get; }
Property Value
Type Description
ErlRef

ValueAsBool

Declaration
public bool ValueAsBool { get; }
Property Value
Type Description
System.Boolean

ValueAsByteArray

Declaration
public byte[] ValueAsByteArray { get; }
Property Value
Type Description
System.Byte[]

ValueAsChar

Declaration
public char ValueAsChar { get; }
Property Value
Type Description
System.Char

ValueAsDateTime

Declaration
public DateTime ValueAsDateTime { get; }
Property Value
Type Description
System.DateTime

ValueAsDecimal

Declaration
public decimal ValueAsDecimal { get; }
Property Value
Type Description
System.Decimal

ValueAsDouble

Declaration
public double ValueAsDouble { get; }
Property Value
Type Description
System.Double

ValueAsInt

Declaration
public int ValueAsInt { get; }
Property Value
Type Description
System.Int32

ValueAsLong

Declaration
public long ValueAsLong { get; }
Property Value
Type Description
System.Int64

ValueAsObject

Declaration
public object ValueAsObject { get; }
Property Value
Type Description
System.Object

ValueAsString

Declaration
public string ValueAsString { get; }
Property Value
Type Description
System.String

ValueAsTimeSpan

Declaration
public TimeSpan ValueAsTimeSpan { get; }
Property Value
Type Description
System.TimeSpan

Methods

Clone()

Clone an instance of the object (non-scalar immutable objects are copied by reference)

Declaration
public IErlObject Clone()
Returns
Type Description
IErlObject

CompareTo(IErlObject)

Compare this instance to the IErlObject. Negative value means that the value is less than obj, positive - greater than the obj

Declaration
public int CompareTo(IErlObject obj)
Parameters
Type Name Description
IErlObject obj
Returns
Type Description
System.Int32

CompareTo(Object)

Compare this instance to the object. Negative value means that the value is less than obj, positive - greater than the obj

Declaration
public int CompareTo(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Int32

Equals(ErlRef)

Determine if two instances are equal

Declaration
public bool Equals(ErlRef rhs)
Parameters
Type Name Description
ErlRef rhs
Returns
Type Description
System.Boolean

Equals(IErlObject)

Determine if two instances are equal

Declaration
public bool Equals(IErlObject o)
Parameters
Type Name Description
IErlObject o
Returns
Type Description
System.Boolean

Equals(Object)

Determine if this instance equals to the object

Declaration
public override bool Equals(object o)
Parameters
Type Name Description
System.Object o
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Get internal hash code

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()

Match(IErlObject)

Perform pattern match on this Erlang term returning null if match fails or a dictionary of matched variables bound in the pattern

Declaration
public ErlVarBind Match(IErlObject pattern)
Parameters
Type Name Description
IErlObject pattern
Returns
Type Description
ErlVarBind

Match(IErlObject, ErlVarBind)

Perform pattern match on this Erlang term, storing matched variables found in the pattern into the binding.

Declaration
public bool Match(IErlObject pattern, ErlVarBind binding)
Parameters
Type Name Description
IErlObject pattern
ErlVarBind binding
Returns
Type Description
System.Boolean

Matches(IErlObject)

Perform pattern match on this Erlang term without binding any variables

Declaration
public bool Matches(IErlObject pattern)
Parameters
Type Name Description
IErlObject pattern
Returns
Type Description
System.Boolean

Parse(String)

Declaration
public static ErlRef Parse(string eref)
Parameters
Type Name Description
System.String eref
Returns
Type Description
ErlRef

Subst(ref IErlObject, ErlVarBind)

Declaration
public bool Subst(ref IErlObject term, ErlVarBind binding)
Parameters
Type Name Description
IErlObject term
ErlVarBind binding
Returns
Type Description
System.Boolean

ToString()

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

TryParse(String, out ErlRef)

Declaration
public static bool TryParse(string eref, out ErlRef erlRef)
Parameters
Type Name Description
System.String eref
ErlRef erlRef
Returns
Type Description
System.Boolean

Visit<TAccumulate>(TAccumulate, Func<TAccumulate, IErlObject, TAccumulate>)

Execute fun for every nested term

Declaration
public TAccumulate Visit<TAccumulate>(TAccumulate acc, Func<TAccumulate, IErlObject, TAccumulate> fun)
Parameters
Type Name Description
TAccumulate acc
System.Func<TAccumulate, IErlObject, TAccumulate> fun
Returns
Type Description
TAccumulate
Type Parameters
Name Description
TAccumulate

Operators

Equality(ErlRef, ErlRef)

Declaration
public static bool operator ==(ErlRef lhs, ErlRef rhs)
Parameters
Type Name Description
ErlRef lhs
ErlRef rhs
Returns
Type Description
System.Boolean

Inequality(ErlRef, ErlRef)

Declaration
public static bool operator !=(ErlRef lhs, ErlRef rhs)
Parameters
Type Name Description
ErlRef lhs
ErlRef rhs
Returns
Type Description
System.Boolean

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

Implements

System.IComparable
System.IComparable<T>
System.IEquatable<T>
System.ICloneable

Extension Methods