diff options
| author | Alex Beregszaszi <alex@rtfs.hu> | 2017-08-22 06:41:46 +0800 |
|---|---|---|
| committer | Alex Beregszaszi <alex@rtfs.hu> | 2017-08-23 01:25:46 +0800 |
| commit | b1cdf81506de39502db0fb4a4b55ba8155f853ab (patch) | |
| tree | 023cefa5a9f00b0e6a5bf84d02745ab8e6666121 /docs | |
| parent | 70bb1e74788b7c2938ab15e14ee048cf9a1a7743 (diff) | |
| download | dexon-solidity-b1cdf81506de39502db0fb4a4b55ba8155f853ab.tar.gz dexon-solidity-b1cdf81506de39502db0fb4a4b55ba8155f853ab.tar.zst dexon-solidity-b1cdf81506de39502db0fb4a4b55ba8155f853ab.zip | |
Document view functions
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/abi-spec.rst | 2 | ||||
| -rw-r--r-- | docs/contracts.rst | 19 | ||||
| -rw-r--r-- | docs/miscellaneous.rst | 5 |
3 files changed, 15 insertions, 11 deletions
diff --git a/docs/abi-spec.rst b/docs/abi-spec.rst index a9110a0a..159bd6c7 100644 --- a/docs/abi-spec.rst +++ b/docs/abi-spec.rst @@ -293,7 +293,7 @@ The JSON format for a contract's interface is given by an array of function and/ * `name`: the name of the parameter; * `type`: the canonical type of the parameter. - `outputs`: an array of objects similar to `inputs`, can be omitted if function doesn't return anything; -- `constant`: `true` if function is :ref:`specified to not modify blockchain state <constant-functions>`); +- `constant`: `true` if function is :ref:`specified to not modify blockchain state <view-functions>`); - `payable`: `true` if function accepts ether, defaults to `false`; - `statemutability`: a string with one of the following values: `view` (same as `constant` above), `nonpayable` and `payable` (same as `payable` above). diff --git a/docs/contracts.rst b/docs/contracts.rst index 7b972e17..0f1a882c 100644 --- a/docs/contracts.rst +++ b/docs/contracts.rst @@ -461,29 +461,32 @@ value types and strings. } -.. _constant-functions: +.. _view-functions: -****************** -Constant Functions -****************** +************** +View Functions +************** -Functions can be declared constant in which case they promise not to modify the state. +Functions can be declared ``view`` in which case they promise not to modify the state. :: pragma solidity ^0.4.0; contract C { - function f(uint a, uint b) constant returns (uint) { + function f(uint a, uint b) view returns (uint) { return a * (b + 42); } } .. note:: - Getter methods are marked constant. + ``constant`` is an alias to ``view``. + +.. note:: + Getter methods are marked ``view``. .. warning:: - The compiler does not enforce yet that a constant method is not modifying state. + The compiler does not enforce yet that a ``view`` method is not modifying state. .. index:: ! fallback function, function;fallback diff --git a/docs/miscellaneous.rst b/docs/miscellaneous.rst index 199182d3..7889fff2 100644 --- a/docs/miscellaneous.rst +++ b/docs/miscellaneous.rst @@ -505,11 +505,12 @@ Function Visibility Specifiers Modifiers ========= +- ``view`` for functions: Disallow modification of state - this is not enforced yet. +- ``payable`` for functions: Allows them to receive Ether together with a call. - ``constant`` for state variables: Disallows assignment (except initialisation), does not occupy storage slot. -- ``constant`` for functions: Disallows modification of state - this is not enforced yet. +- ``constant`` for functions: Same as ``view``. - ``anonymous`` for events: Does not store event signature as topic. - ``indexed`` for event parameters: Stores the parameter as topic. -- ``payable`` for functions: Allows them to receive Ether together with a call. Reserved Keywords ================= |