Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify that functions can return references under certain conditions #8644

Merged
merged 2 commits into from
Jun 15, 2023
Merged

Specify that functions can return references under certain conditions #8644

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae3d684
Add note that functions can return references
saharct Jun 13, 2023
ecd0c5d
Mention that inline functions can return such references
saharct Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions developer-docs-site/docs/move/book/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,10 @@ fun zero(): u64 { 0 }

Here `: u64` indicates that the function's return type is `u64`.

:::tip
A function can return an immutable `&` or mutable `&mut` [reference](./references.md) if derived from an input reference. Keep in mind, this means that a function [cannot return a reference to global storage](./references.md#references-cannot-be-stored) unless it is an [inline function](#inline-functions).
:::

Using tuples, a function can return multiple values:

```move
Expand Down