[#bsl-operator_eq-0c5]
= xref:bsl.adoc[bsl]::operator==
:relfileprefix: ../
:mrdocs:

Return whether `lhs` and `rhs` refer to the same stop state.

== Synopsis

Declared in `<bslstl_stoptoken.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
bool
operator==(
    xref:bsl/stop_token.adoc[stop_token] const& lhs,
    xref:bsl/stop_token.adoc[stop_token] const& rhs) noexcept;
----

== Description

Return `true` if the specified `lhs` and `rhs` refer to the same stop state, or if neither refers to a stop state; `false` otherwise. Implementation note: this function is required by the standard to be a hidden friend ([hidden.friends], [stoptoken.general]).

== Return Value

`true` if both refer to the same stop state (or neither)

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *lhs*
| left‐hand operand
| *rhs*
| right‐hand operand
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#