Class Value

Represents a value that Fluency functions operate on.

Inheritance
System.Object
Value
Implements
System.IEquatable<Value>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Fluency.Execution.Functions
Assembly: Execution.dll
Syntax
public class Value : IEquatable<Value>

Constructors

| Improve this Doc View Source

Value(Argument)

Construct a value from a parsed function argument.

Declaration
public Value(Argument arg)
Parameters
Type Name Description
Argument arg
| Improve this Doc View Source

Value(Object, FluencyType)

Construct a value from a C# value and a type.

Declaration
public Value(object value, FluencyType type)
Parameters
Type Name Description
System.Object value
FluencyType type

Properties

| Improve this Doc View Source

Done

Returned when the called function has no more work to do.

Declaration
public bool Done { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Finished

The "done" Value that indicates there's no more work.

Declaration
public static Value Finished { get; }
Property Value
Type Description
Value
| Improve this Doc View Source

Type

The type of this value.

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

Methods

| Improve this Doc View Source

Equals(Value)

Two Values are equal if and only if:

  • they are both Done OR
  • neither of them are done AND they have the same type and value.
Declaration
public bool Equals(Value other)
Parameters
Type Name Description
Value other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

Get<T>(Nullable<FluencyType>, String)

Get the value inside the type.

Declaration
public T Get<T>(FluencyType? expected = default(FluencyType? ), string failMessage = null)
Parameters
Type Name Description
System.Nullable<FluencyType> expected
System.String failMessage
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

ToString()

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

Operators

| Improve this Doc View Source

Implicit(Value to Boolean)

The Done value converts to false, all others to true. This is so you can do something like (while (NextValue()) { doSomething(); }

Declaration
public static implicit operator bool (Value v)
Parameters
Type Name Description
Value v
Returns
Type Description
System.Boolean

Implements

System.IEquatable<T>