diff options
author | Chris Chinchilla <chriswhward@gmail.com> | 2019-01-14 17:55:48 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-14 17:55:48 +0800 |
commit | dea9999f47dfe9c0a54dd2251758c88fa055f532 (patch) | |
tree | aa8f94d955430db37d75ed3d9b9dc99a0c0751d7 /docs/types.rst | |
parent | 6d4d0a53088c6864593db447408feb17f59ee0d8 (diff) | |
parent | 29088c4f4852049da5a5b43403b2a70cb4eb9795 (diff) | |
download | dexon-solidity-dea9999f47dfe9c0a54dd2251758c88fa055f532.tar.gz dexon-solidity-dea9999f47dfe9c0a54dd2251758c88fa055f532.tar.zst dexon-solidity-dea9999f47dfe9c0a54dd2251758c88fa055f532.zip |
Merge pull request #5770 from ethereum/docs-split-mapping-types
[DOCS] Split mapping types into new file
Diffstat (limited to 'docs/types.rst')
-rw-r--r-- | docs/types.rst | 59 |
1 files changed, 1 insertions, 58 deletions
diff --git a/docs/types.rst b/docs/types.rst index 54e6ca7f..b9c06f6c 100644 --- a/docs/types.rst +++ b/docs/types.rst @@ -22,64 +22,7 @@ tuple with a second `bool` value denoting success. .. include:: types/reference-types.rst -.. index:: !mapping -.. _mapping-types: - -Mapping Types -============= - -You declare mapping types with the syntax ``mapping(_KeyType => _ValueType)``. -The ``_KeyType`` can be any elementary type. This means it can be any of -the built-in value types plus ``bytes`` and ``string``. User-defined -or complex types like contract types, enums, mappings, structs and any array type -apart from ``bytes`` and ``string`` are not allowed. -``_ValueType`` can be any type, including mappings. - -You can think of mappings as `hash tables <https://en.wikipedia.org/wiki/Hash_table>`_, which are virtually initialised -such that every possible key exists and is mapped to a value whose -byte-representation is all zeros, a type's :ref:`default value <default-value>`. The similarity ends there, the key data is not stored in a -mapping, only its ``keccak256`` hash is used to look up the value. - -Because of this, mappings do not have a length or a concept of a key or -value being set. - -Mappings can only have a data location of ``storage`` and thus -are allowed for state variables, as storage reference types -in functions, or as parameters for library functions. -They cannot be used as parameters or return parameters -of contract functions that are publicly visible. - -You can mark variables of mapping type as ``public`` and Solidity creates a -:ref:`getter <visibility-and-getters>` for you. The ``_KeyType`` becomes a -parameter for the getter. If ``_ValueType`` is a value type or a struct, -the getter returns ``_ValueType``. -If ``_ValueType`` is an array or a mapping, the getter has one parameter for -each ``_KeyType``, recursively. For example with a mapping: - -:: - - pragma solidity >=0.4.0 <0.6.0; - - contract MappingExample { - mapping(address => uint) public balances; - - function update(uint newBalance) public { - balances[msg.sender] = newBalance; - } - } - - contract MappingUser { - function f() public returns (uint) { - MappingExample m = new MappingExample(); - m.update(100); - return m.balances(address(this)); - } - } - - -.. note:: - Mappings are not iterable, but it is possible to implement a data structure - on top of them. For an example, see `iterable mapping <https://github.com/ethereum/dapp-bin/blob/master/library/iterable_mapping.sol>`_. +.. include:: types/mapping-types.rst .. include:: types/operators.rst |