ErlAtom Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The ErlAtom type exposes the following members.

Constructors

	Name	Description
	ErlAtom(String)	Create an atom from the given string
	ErlAtom(ErlAtom)	Initializes a new instance of the ErlAtom class
	ErlAtom( Byte , Int32 , Int32)	Initializes a new instance of the ErlAtom class

Methods

	Name	Description
	Clone	Clone an instance of the object (non-scalar immutable objects are copied by reference)
	CompareTo(Object)	Compare this instance to the object. Negative value means that the atom is less than obj, positive - greater than the obj
	CompareTo(IErlObject)	Compare this instance to the IErlObject. Negative value means that the atom is less than obj, positive - greater than the obj
	Equals(Object)	Determine if this atom equals to the object (Overrides ValueType Equals(Object).)
	Equals(IErlObject)	Determine if two atoms are equal
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Get internal hash code (Overrides ValueType GetHashCode .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match(IErlObject)	Perform pattern match on this Erlang term returning null if match fails or a dictionary of matched variables bound in the pattern
	Match(IErlObject, ErlVarBind)	Perform pattern match on this Erlang term, storing matched variables found in the pattern into the binding.
	Matches	Perform pattern match on this Erlang term without binding any variables
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Subst
	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 (Overrides ValueType ToString .)
	Visit TAccumulate	Execute fun for every nested term

Operators

	Name	Description
	Equality
	(String to ErlAtom)	Implicit conversion of string to atom
	(ErlAtom to String)	Implicit conversion of atom to string
	Inequality

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsType	Tries to convert an Erlang term as specified native type. Throw exception if conversion is not possible (Defined by ErlObject.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	IsInt	Determines if Erlang object is of type ErlByte or ErlLong (Defined by ErlObject.)
	IsNull	Determines if Erlang object is NULL - that is ErlAtom.Undefined or null reference (Defined by ErlObject.)
	Subst	Substibute all variables in the given object using provided binding and return the resulting object (Defined by ErlObject.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	False
	Index	The index of this atom in the global atom table
	Normal
	Null
	True
	Undefined

Properties

	Name	Description
	Empty	Returns true if this instance equals ErlAtom.Null
	IsScalar	Determines whether the underlying type is scalar or complex (i.e. tuple, list)
	Length	Return the length of the atom string
	TypeOrder
	Value	Get the actual string contained in this object
	ValueAsBool
	ValueAsByteArray
	ValueAsChar
	ValueAsDateTime
	ValueAsDecimal
	ValueAsDouble
	ValueAsInt
	ValueAsLong
	ValueAsObject
	ValueAsString
	ValueAsTimeSpan

Explicit Interface Implementations

	Name	Description
	ICloneable Clone