Struct ErlAtom

Implements
IErlObject<System.String>
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 ErlAtom : IErlObject<string>, IErlObject, IComparable, IComparable<IErlObject>, IEquatable<IErlObject>, ICloneable

Constructors

ErlAtom(ErlAtom)

Declaration
public ErlAtom(ErlAtom atom)
Parameters
Type Name Description
ErlAtom atom

ErlAtom(Byte[], ref Int32, Int32)

Declaration
public ErlAtom(byte[] buf, ref int offset, int count)
Parameters
Type Name Description
System.Byte[] buf
System.Int32 offset
System.Int32 count

ErlAtom(String)

Create an atom from the given string

Declaration
public ErlAtom(string atom)
Parameters
Type Name Description
System.String atom

Fields

False

Declaration
public static readonly ErlAtom False
Field Value
Type Description
ErlAtom

Index

The index of this atom in the global atom table

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

Normal

Declaration
public static readonly ErlAtom Normal
Field Value
Type Description
ErlAtom

Null

Declaration
public static readonly ErlAtom Null
Field Value
Type Description
ErlAtom

True

Declaration
public static readonly ErlAtom True
Field Value
Type Description
ErlAtom

Undefined

Declaration
public static readonly ErlAtom Undefined
Field Value
Type Description
ErlAtom

Properties

Empty

Returns true if this instance equals ErlAtom.Null

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

IsScalar

Determines whether the underlying type is scalar or complex (i.e. tuple, list)

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

Length

Return the length of the atom string

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

TypeOrder

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

Value

Get the actual string contained in this object

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

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 atoms are equal

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

Equals(Object)

Determine if this atom 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

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

Get the printname of the atom represented by this object. The difference between this method and {link #atomValue atomValue()} is that the printname is quoted and escaped where necessary, according to the Erlang rules for atom naming

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

Operators

Equality(ErlAtom, ErlAtom)

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

Implicit(ErlAtom to String)

Implicit conversion of atom to string

Declaration
public static implicit operator string (ErlAtom a)
Parameters
Type Name Description
ErlAtom a
Returns
Type Description
System.String

Implicit(String to ErlAtom)

Implicit conversion of string to atom

Declaration
public static implicit operator ErlAtom(string a)
Parameters
Type Name Description
System.String a
Returns
Type Description
ErlAtom

Inequality(ErlAtom, ErlAtom)

Declaration
public static bool operator !=(ErlAtom lhs, ErlAtom rhs)
Parameters
Type Name Description
ErlAtom lhs
ErlAtom 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