PayloadKind in reth_node_api - Rust

PayloadKind in reth_node_api - Rust

pub enum PayloadKind {
    Earliest,
    WaitForPending,
}

Expand description

Determines how we should choose the payload to return.

Returns the next best available payload (the earliest available payload). This does not wait for a real for pending job to finish if there’s no best payload yet and is allowed to race various payload jobs (empty, pending best) against each other and returns whichever job finishes faster.

This should be used when it’s more important to return a valid payload as fast as possible. For example, the engine API timeout for engine_getPayload is 1s and clients should rather return an empty payload than indefinitely waiting for the pending payload job to finish and risk missing the deadline.

Only returns once we have at least one built payload.

Compared to PayloadKind::Earliest this does not race an empty payload job against the already in progress one, and returns the best available built payload or awaits the job in progress.

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dest. Read more

Compare self to key and return true if they are equal.

Checks if this value is equivalent to the given key. Read more

Checks if this value is equivalent to the given key. Read more

Checks if this value is equivalent to the given key. Read more

Causes self to use its Binary implementation when Debug-formatted.

Causes self to use its Display implementation when Debug-formatted.

Causes self to use its LowerExp implementation when Debug-formatted.

Causes self to use its LowerHex implementation when Debug-formatted.

Causes self to use its Octal implementation when Debug-formatted.

Causes self to use its Pointer implementation when Debug-formatted.

Causes self to use its UpperExp implementation when Debug-formatted.

Causes self to use its UpperHex implementation when Debug-formatted.

Formats each item in a sequence. Read more

Returns the argument unchanged.

Builds a [TxEnv] from a transaction and a sender address.

Builds a [TxEnv] from a transaction, its sender, and encoded transaction bytes.

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

Attaches the current Context to this type, returning a WithContext wrapper. Read more

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Wrap the input message T in a tonic::Request

Applies the layer to a service and wraps it in [Layered].

Pipes by value. This is generally the method you want to use. Read more

Borrows self and passes that borrow into the pipe function. Read more

Mutably borrows self and passes that borrow into the pipe function. Read more

Borrows self, then passes self.borrow() into the pipe function. Read more

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Borrows self, then passes self.as_ref() into the pipe function.

Mutably borrows self, then passes self.as_mut() into the pipe function.

Borrows self, then passes self.deref() into the pipe function.

Mutably borrows self, then passes self.deref_mut() into the pipe function.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

Available on crate feature propagate-header only.

Propagate a header from the request to the response. Read more

Available on crate feature add-extension only.

Available on crate feature map-request-body only.

Apply a transformation to the request body. Read more

Available on crate feature map-response-body only.

Apply a transformation to the response body. Read more

Available on crate features compression-br or compression-deflate or compression-gzip or compression-zstd only.

Compresses response bodies. Read more

Available on crate features decompression-br or decompression-deflate or decompression-gzip or decompression-zstd only.

Decompress response bodies. Read more

Available on crate feature trace only.

High level tracing that classifies responses using HTTP status codes. Read more

Available on crate feature trace only.

High level tracing that classifies responses using gRPC headers. Read more

Available on crate feature follow-redirect only.

Available on crate feature sensitive-headers only.

Available on crate feature sensitive-headers only.

Available on crate feature sensitive-headers only.

Available on crate feature set-header only.

Insert a header into the request. Read more

Available on crate feature set-header only.

Append a header into the request. Read more

Available on crate feature set-header only.

Insert a header into the request, if the header is not already present. Read more

Available on crate feature set-header only.

Insert a header into the response. Read more

Available on crate feature set-header only.

Append a header into the response. Read more

Available on crate feature set-header only.

Insert a header into the response, if the header is not already present. Read more

Available on crate feature request-id only.

Add request id header and extension. Read more

Available on crate feature request-id only.

Add request id header and extension, using x-request-id as the header name. Read more

Available on crate feature request-id only.

Propgate request ids from requests to responses. Read more

Available on crate feature request-id only.

Propgate request ids from requests to responses, using x-request-id as the header name. Read more

Available on crate feature catch-panic only.

Catch panics and convert them into 500 Internal Server responses. Read more

Available on crate feature limit only.

Intercept requests with over-sized payloads and convert them into 413 Payload Too Large responses. Read more

Available on crate feature normalize-path only.

Remove trailing slashes from paths. Read more

Available on crate feature normalize-path only.

Append trailing slash to paths. Read more

Immutable access to a value. Read more

Immutable access to the Borrow<B> of a value. Read more

Mutable access to the BorrowMut<B> of a value. Read more

Immutable access to the AsRef<R> view of a value. Read more

Mutable access to the AsMut<R> view of a value. Read more

Immutable access to the Deref::Target of a value. Read more

Mutable access to the Deref::Target of a value. Read more

Calls .tap() only in debug builds, and is erased in release builds.

Calls .tap_mut() only in debug builds, and is erased in release builds.

Calls .tap_borrow() only in debug builds, and is erased in release builds.

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

Calls .tap_ref() only in debug builds, and is erased in release builds.

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

Calls .tap_deref() only in debug builds, and is erased in release builds.

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Clones self, possibly returning an error.

Attempts to convert self into T using TryInto<T>. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

Earliest: 0 bytes
WaitForPending: 0 bytes