[#FeeRateEstimation]
= FeeRateEstimation
:mrdocs:

A successful fee rate estimate returned by a fee rate estimator.

== Synopsis

Declared in `<util/fees.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct FeeRateEstimation;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:FeeRateEstimation/operator_3way.adoc[`operator<=>`] 
| Compare two FeeRateEstimation objects based on fee rate
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:FeeRateEstimation/feerate.adoc[`feerate`] 
| Fee rate sufficient for confirmation within target.
| xref:FeeRateEstimation/feerate_estimator.adoc[`feerate_estimator`] 
| This identifies which fee rate estimator is providing this feerate estimate
| xref:FeeRateEstimation/returned_target.adoc[`returned_target`] 
| The returned confirmation target for the estimate.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:FeeRateEstimationRef.adoc[`FeeRateEstimationRef`]
| Return the estimation carried by a fee rate estimate result: the successful estimation, or the error's zero‐value estimation.
|===


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