cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add sections for state mutability and special functions

Browse Source
This commit is contained in:
Nikita Stupin 2021-09-10 11:27:55 +03:00
parent dea1b9ec79
commit aedf29b9dd
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/contracts/functions.rst
View File

@ -155,12 +155,17 @@ When a function has multiple return types, the statement ``return (v0, v1, ...,
The number of components must be the same as the number of return variables The number of components must be the same as the number of return variables
and their types have to match, potentially after an :ref:`implicit conversion <types-conversion-elementary-types>`. and their types have to match, potentially after an :ref:`implicit conversion <types-conversion-elementary-types>`.
.. _state-mutability:
State Mutability
================
.. index:: ! view function, function;view .. index:: ! view function, function;view
.. _view-functions: .. _view-functions:
View Functions View Functions
============== --------------
Functions can be declared ``view`` 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.
@ -214,7 +219,7 @@ The following statements are considered modifying the state:
.. _pure-functions: .. _pure-functions:
Pure Functions Pure Functions
============== --------------
Functions can be declared ``pure`` in which case they promise not to read from or modify the state. Functions can be declared ``pure`` in which case they promise not to read from or modify the state.
@ -270,12 +275,17 @@ This behaviour is also in line with the ``STATICCALL`` opcode.
not do state-changing operations, but it cannot check that the contract that will be called not do state-changing operations, but it cannot check that the contract that will be called
at runtime is actually of that type. at runtime is actually of that type.
.. _special-functions:
Special Functions
=================
.. index:: ! receive ether function, function;receive ! receive .. index:: ! receive ether function, function;receive ! receive
.. _receive-ether-function: .. _receive-ether-function:
Receive Ether Function Receive Ether Function
====================== ----------------------
A contract can have at most one ``receive`` function, declared using A contract can have at most one ``receive`` function, declared using
``receive() external payable { ... }`` ``receive() external payable { ... }``
@ -346,7 +356,7 @@ Below you can see an example of a Sink contract that uses function ``receive``.
.. _fallback-function: .. _fallback-function:
Fallback Function Fallback Function
================= -----------------
A contract can have at most one ``fallback`` function, declared using either ``fallback () external [payable]`` A contract can have at most one ``fallback`` function, declared using either ``fallback () external [payable]``
or ``fallback (bytes calldata _input) external [payable] returns (bytes memory _output)`` or ``fallback (bytes calldata _input) external [payable] returns (bytes memory _output)``