ValueTuple<T1> Structure

Represents a value tuple with a single component.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

generic<typename T1>
public value struct ValueTuple : IEquatable<ValueTuple<T1>>, 
	IStructuralEquatable, IStructuralComparable, IComparable, IComparable<ValueTuple<T1>>

Type Parameters

T1: The type of the value tuple's only element.

Constructors

	Name	Description
	ValueTuple<T1>(T1)	Initializes a new ValueTuple<T1> instance.

Methods

	Name	Description
	CompareTo(ValueTuple<T1>)	Compares the current ValueTuple<T1> instance to a specified ValueTuple<T1> instance.
	Equals(Object^)	Returns a value that indicates whether the current ValueTuple<T1> instance is equal to a specified object.(Overrides ValueType::Equals(Object^).)
	Equals(ValueTuple<T1>)	Returns a value that indicates whether the current ValueTuple<T1> instance is equal to a specified ValueTuple<T1> instance.
	GetHashCode()	Calculates the hash code for the current ValueTuple<T1> instance.(Overrides ValueType::GetHashCode().)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	ToString()	Returns a string that represents the value of this ValueTuple<T1> instance. (Overrides ValueType::ToString().)

Fields

	Name	Description
	Item1	Gets the value of the current ValueTuple<T1> instance's first element.

Explicit Interface Implementations

	Name	Description
	IStructuralComparable::CompareTo(Object^, IComparer^)	Compares the current ValueTuple<T1> instance to a specified object by using a specified comparer and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.
	IStructuralEquatable::Equals(Object^, IEqualityComparer^)	Returns a value that indicates whether the current ValueTuple<T1> instance is equal to a specified object based on a specified comparison method.
	IStructuralEquatable::GetHashCode(IEqualityComparer^)	Calculates the hash code for the current ValueTuple<T1> instance by using a specified computation method.
	IComparable::CompareTo(Object^)	Compares the current ValueTuple<T1> instance to a specified object by using a specified comparer and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.

Extension Methods

	Name	Description
	ToTuple<T1>()	Overloaded. Converts an instance of the ValueTuple structure to an instance of the Tuple class. (Defined by TupleExtensions.)

Remarks

A value tuple is a data structure that has a specific number and sequence of values. The ValueTuple<T1> structure represents a value tuple that has one element.

The value tuple types differ from the tuple types (such as Tuple<T1> as follows:

They are structures (value types) rather than classes (reference types).
Its Item1 member is a field rather than a property.
Its field is mutable rather than read-only.

The value tuple types provide the runtime implementation that supports tuples in C# and struct tuples in F#. In addition to creating a ValueTuple<T1> instance by using language syntax, you can call the ValueTuple::Create<T1>(T1) factory method.

Version Information

.NET Framework
Available since 4.7

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.