Struct ErlVar

Provides a C# representation of an Erlang variable

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 ErlVar : IErlObject, IComparable, IComparable<IErlObject>, IEquatable<IErlObject>, ICloneable

Constructors

ErlVar(ErlAtom, ErlTypeOrder)

Create an Erlang typed named variable using ErlAtom as name

Declaration
public ErlVar(ErlAtom name, ErlTypeOrder type = ErlTypeOrder.ErlObject)
Parameters
Type Name Description
ErlAtom name

Variable name
ErlTypeOrder type

Value type

ErlVar(String)

Create an Erlang named variable

Declaration
public ErlVar(string name)
Parameters
Type Name Description
System.String name

Variable name

ErlVar(String, ErlTypeOrder)

Create an Erlang typed named variable

Declaration
public ErlVar(string name, ErlTypeOrder type)
Parameters
Type Name Description
System.String name

Variable name
ErlTypeOrder type

Value type

Fields

Any

Declaration
public static readonly ErlVar Any
Field Value
Type Description
ErlVar

ValueType

Type of value stored in this variable

Declaration
public readonly ErlTypeOrder ValueType
Field Value
Type Description
ErlTypeOrder

Properties

IsAny

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

IsScalar

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

Name

Variable name

Declaration
public ErlAtom Name { get; }
Property Value
Type Description
ErlAtom

TypeOrder

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

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 atom 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 atom 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(IErlObject)

Determine if two vars are equal

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

Equals(Object)

Determine if this var 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)

Match this variable with given pattern merely by performing type check

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

Subst(ref IErlObject, ErlVarBind)

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

ToString()

Get the printable version of the string contained in this object

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

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

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