Skip to content

Commit 187b1f9

Browse files
committed
fix: docs
1 parent cc8e0d7 commit 187b1f9

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

src/inspectors/timeout.rs

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,8 @@ use std::time::{Duration, Instant};
2424
/// - any invalid opcode
2525
///
2626
/// When execution is terminated by the timer, it will result in a
27-
/// [`InstructionResult::CallTooDeep`]. This is somewhat unintutive. `revm`
28-
/// uses the [`InstructionResult`] enum to represent possible outcomes of a
29-
/// opcode. It requires that the inspector's outcome is a valid
30-
/// [`InstructionResult`], but does not provide a way to represent a custom
31-
/// outcome. This means that the inspector must overload an existing outcome.
32-
/// `CallTooDeep` is used here because it is effectively unreachable in normal
33-
/// `evm` execution due to [EIP-150] call gas forwarding rules, and therefore
34-
/// overloading it is unlikely to cause issues.
27+
/// [`ContextError::Custom`], which will be propagated as an
28+
/// [`EVMError::Custom`] to the caller of the EVM interpreter.
3529
///
3630
/// ## Usage Note
3731
///
@@ -46,6 +40,7 @@ use std::time::{Duration, Instant};
4640
/// discarded.
4741
///
4842
/// [EIP-150]: https://eips.ethereum.org/EIPS/eip-150
43+
/// [`EVMError::Custom`]: revm::context::result::EVMError::Custom
4944
#[derive(Debug, Clone, Copy)]
5045
pub struct TimeLimit {
5146
duration: Duration,

0 commit comments

Comments
 (0)