Span<T>.Equals(Object) Method

  • Reference

Definition

Namespace:
System
Assembly:
System.Runtime.dll
Assembly:
System.Memory.dll
Assembly:
netstandard.dll
Package:
System.Memory v4.5.5
Source:
Span.cs
Source:
Span.cs
Source:
Span.cs

Caution

Equals() on Span will always throw an exception. Use == instead.

Caution

Equals() on Span will always throw an exception. Use the equality operator instead.

Calls to this method are not supported.

public:
 override bool Equals(System::Object ^ obj);
[System.Obsolete("Equals() on Span will always throw an exception. Use == instead.")]
public override bool Equals (object? obj);
[System.Obsolete("Equals() on Span will always throw an exception. Use the equality operator instead.")]
public override bool Equals (object? obj);
[System.Obsolete("Equals() on Span will always throw an exception. Use == instead.")]
public override bool Equals (object obj);
[<System.Obsolete("Equals() on Span will always throw an exception. Use == instead.")>]
override this.Equals : obj -> bool
[<System.Obsolete("Equals() on Span will always throw an exception. Use the equality operator instead.")>]
override this.Equals : obj -> bool
Public Overrides Function Equals (obj As Object) As Boolean

Parameters

obj
Object

Not supported.

Returns

Boolean

Calls to this method are not supported.

Attributes
ObsoleteAttribute

Exceptions

NotSupportedException

Calls to this method are not supported.

Remarks

Calls to the Equals method are not supported. Calls to the Equals methods produce either of two results:

  • If obj is a Span<T>, the method call generates compiler error CS1503: "cannot convert from 'System.Span' to 'object'." This is because Span<T> is a ref struct that cannot be boxed and therefore cannot be converted to an Object.

  • If the type of obj is not a Span<T>, the method call throws a NotSupportedException.

To compare two Span<T> objects for equality, use the Equality comparison operator.

Applies to