[#node-FlattenMiningOptions]
= xref:node.adoc[node]::FlattenMiningOptions
:relfileprefix: ../
:mrdocs:

Replace null optional values with their hardcoded defaults.

== Synopsis

Declared in `<node/mining_args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
xref:node/BlockCreateOptions.adoc[BlockCreateOptions]
FlattenMiningOptions(xref:node/BlockCreateOptions.adoc[BlockCreateOptions] options);
----

== Return Value

A copy of `options` with every null field replaced by its default.

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

[cols="1,4"]
|===
| Name| Description
| *options*
| The block‐creation options to fill in.
|===


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