Display the source code in core/atomic.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `core.atomic.atomicLoad`

Loads 'val' from memory and returns it. The memory barrier specified by 'ms' is applied to the operation, which is fully sequenced by default. Valid memory orders are MemoryOrder.raw, MemoryOrder.acq, and MemoryOrder.seq.


						
				T atomicLoad(MemoryOrder ms = MemoryOrder.seq, T)
				(
				

				  auto scope const ref return T val
				

				) pure nothrow @nogc @trusted
				

				if (!is(T == shared(U), U) && !is(T == shared(inout(U)), U) && !is(T == shared(const(U)), U));
				

				

				T atomicLoad(MemoryOrder ms = MemoryOrder.seq, T)
				(
				

				  auto scope const shared ref return T val
				

				) pure nothrow @nogc @trusted
				

				if (!hasUnsharedIndirections!T);
				

				

				TailShared!T atomicLoad(MemoryOrder ms = MemoryOrder.seq, T)
				(
				

				  auto const shared ref T val
				

				) pure nothrow @nogc @trusted
				

				if (hasUnsharedIndirections!T);

Parameters

Name	Description
val	The target variable.

Returns

The value of 'val'.

Authors

Sean Kelly, Alex Rønne Petersen, Manu Evans

License

Boost License 1.0