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

Merge pull request #5753 from ethereum/docs-split-interfaces

Browse Source 
[DOCS] Split interfaces into new file
This commit is contained in:
chriseth 2019-01-08 00:05:24 +01:00 committed by GitHub
commit 44de865da1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/contracts.rst
View File

@ -534,43 +534,7 @@ converted to ``uint8``.
.. include:: contracts/inheritance.rst
.. include:: contracts/abstract-contracts.rst
.. index:: ! contract;interface, ! interface contract
.. _interfaces:
**********
Interfaces
**********
Interfaces are similar to abstract contracts, but they cannot have any functions implemented. There are further restrictions:
- They cannot inherit other contracts or interfaces.
- All declared functions must be external.
- They cannot declare a constructor.
- They cannot declare state variables.
Some of these restrictions might be lifted in the future.
Interfaces are basically limited to what the Contract ABI can represent, and the conversion between the ABI and
an interface should be possible without any information loss.
Interfaces are denoted by their own keyword:
::
pragma solidity ^0.5.0;
interface Token {
enum TokenType { Fungible, NonFungible }
struct Coin { string obverse; string reverse; }
function transfer(address recipient, uint amount) external;
}
Contracts can inherit interfaces as they would inherit other contracts.
Types defined inside interfaces and other contract-like structures
can be accessed from other contracts: ``Token.TokenType`` or ``Token.Coin``.
.. include:: contracts/interfaces.rst
.. index:: ! library, callcode, delegatecall

36
docs/contracts/interfaces.rst Normal file
View File

@ -0,0 +1,36 @@
.. index:: ! contract;interface, ! interface contract
.. _interfaces:
**********
Interfaces
**********
Interfaces are similar to abstract contracts, but they cannot have any functions implemented. There are further restrictions:
- They cannot inherit other contracts or interfaces.
- All declared functions must be external.
- They cannot declare a constructor.
- They cannot declare state variables.
Some of these restrictions might be lifted in the future.
Interfaces are basically limited to what the Contract ABI can represent, and the conversion between the ABI and
an interface should be possible without any information loss.
Interfaces are denoted by their own keyword:
::
pragma solidity ^0.5.0;
interface Token {
enum TokenType { Fungible, NonFungible }
struct Coin { string obverse; string reverse; }
function transfer(address recipient, uint amount) external;
}
Contracts can inherit interfaces as they would inherit other contracts.
Types defined inside interfaces and other contract-like structures
can be accessed from other contracts: ``Token.TokenType`` or ``Token.Coin``.