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

Jump to bottom

docs: add sway memory model #6775

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

docs: add sway memory model #6775

wants to merge 7 commits into from

Conversation

matt-user
Copy link
Contributor

Description

Developers get confused by Sway's memory model as it is different from Rust's. So I added this to the docs.

closes https://app.asana.com/0/1207924201336629/1208429018056446

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • x ] I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@matt-user matt-user self-assigned this Dec 5, 2024
@matt-user matt-user requested review from a team as code owners December 5, 2024 17:18
IGI-111
IGI-111 reviewed Dec 6, 2024
View reviewed changes
docs/book/src/reference/rust_differences.md Outdated

In Rust, the borrow checker implements Rust's [ownership system](https://doc.rust-lang.org/1.8.0/book/ownership.html)

In Sway, there is no borrow checker. This means there is no concept of ownership, borrowing, or lifetimes. Instead, objects are copied and moved similar to C++. Also Sway does not have any destructors nor `Drop` traits. This means allocated memory lives for the entire transaction and is not deallocated until the end of the transaction. A transaction can contain 65 MB of memory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a source for the 65 MB number and can that be linked to the spec documentation if that's where it's from? Since that may change in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @FuelLabs/client

sdankel
sdankel approved these changes Dec 9, 2024
View reviewed changes
Copy link
Member

@sdankel sdankel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdankel sdankel sdankel approved these changes

@bitzoic bitzoic Awaiting requested review from bitzoic

@xgreenx xgreenx Awaiting requested review from xgreenx

@IGI-111 IGI-111 Awaiting requested review from IGI-111

At least 2 approving reviews are required to merge this pull request.

Assignees

@matt-user matt-user

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@matt-user @IGI-111 @xgreenx @sdankel @bitzoic