Skip to content

docs: 🏗️ add Rust interface design for discard() - #246

Open
lwjohnst86 wants to merge 15 commits into
mainfrom
docs/add-rust-design-discard
Open

lwjohnst86 wants to merge 15 commits into
mainfrom
docs/add-rust-design-discard

Conversation

@lwjohnst86

@lwjohnst86 lwjohnst86 commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Description

Potential design for discard(), along with signatures and descriptions of some library functions

Needs a thorough review.

Kroki diagram preview here

Checklist

  • Ran just run-all

@lwjohnst86
lwjohnst86 requested a review from a team as a code owner November 2, 2026 08:35
@lwjohnst86
lwjohnst86 added this pull request to stack #251 November 2, 2026 08:47
@lwjohnst86 lwjohnst86 moved this from Todo to In Review in Product development Nov 2, 2026
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch from bf59dbb to cf1aa0f Compare November 2, 2026 09:42

@DanMazJen DanMazJen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Note sure I'm capable of reviewing the implementation here without actually sitting with the code in my own hands – but tried replying to one of the questions :)
Please take that with a grain of salt...

Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch 2 times, most recently from fa748d2 to d75fb99 Compare November 3, 2026 13:58
Comment thread docs/design/interface/rust.qmd Resolved
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch from d75fb99 to 85b47c3 Compare November 6, 2026 10:21

@signekb signekb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A couple of suggestions and a comment:

Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Product development Nov 10, 2026

@signekb signekb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

✏️

Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch from 1b8b022 to c161934 Compare November 10, 2026 10:06
@lwjohnst86
lwjohnst86 requested a review from signekb November 10, 2026 10:14
@lwjohnst86 lwjohnst86 moved this from In Progress to In Review in Product development Nov 10, 2026

@signekb signekb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Minor, minor ✏️

Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Product development Nov 10, 2026

@fruvago fruvago left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A more in-depth review, taking the broader architecture as given.

Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@lwjohnst86 lwjohnst86 moved this from In Progress to In Review in Product development Nov 11, 2026
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch from f962f43 to eda1ed9 Compare November 11, 2026 08:15
Base automatically changed from docs/rust-convert-design to main November 11, 2026 08:21
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch from 5465113 to 1943f9d Compare November 11, 2026 09:49
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@lwjohnst86
lwjohnst86 requested a review from fruvago November 12, 2026 18:34

@signekb signekb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I spent some time yesterday trying to write things out and that lead me to some questions, mostly about the Session struct:

Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Product development Nov 13, 2026
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
Comment thread docs/design/interface/rust.qmd Resolved
@lwjohnst86 lwjohnst86 moved this from In Progress to Approved in Product development Nov 13, 2026
@lwjohnst86 lwjohnst86 moved this from Approved to In Review in Product development Nov 13, 2026

@fruvago fruvago left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Last very small comment

Comment thread docs/design/interface/rust.qmd Outdated
the current deposit on Zenodo needs to be retrieved, do `Session::new()`
again to start over.

`Session::require_deposit(self: &self) -> Result<Self, Error>`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
`Session::require_deposit(self: &self) -> Result<Self, Error>`
`Session::require_deposit(self) -> Result<Self, Error>`

To match the other change

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think based on your previous comments, I'll revise this to be a check on if Session.deposit is empty or not, so we don't need another method

@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Product development Nov 13, 2026
lwjohnst86 and others added 14 commits November 16, 2026 16:46
Co-authored-by: Daniel Mazhari-Jensen <120712445+DanMazJen@users.noreply.github.com>
Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com>
Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com>
Co-authored-by: fruvago <57952344+fruvago@users.noreply.github.com>
Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com>
Co-authored-by: fruvago <57952344+fruvago@users.noreply.github.com>
@lwjohnst86
lwjohnst86 force-pushed the docs/add-rust-design-discard branch from 4beb9e9 to fdb9399 Compare November 16, 2026 15:46
@lwjohnst86
lwjohnst86 requested a review from fruvago November 16, 2026 15:54
@lwjohnst86 lwjohnst86 moved this from In Progress to In Review in Product development Nov 16, 2026

This branch has not been deployed

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

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

4 participants