LiveSplit / LiveSplit/livesplit-core

Document the Move Semantics in the Bindings

Open
#115 0 comments 0 reactions 0 assignees View on GitHub
bindings c api enhancement suitable for contributions
Dominant language
Rust
Stars
227
Forks
81
Avg merge
22h 45m
Merged PRs (30d)
3

Description

The Bindings can easily be misused (less so where we have garbage collector integration) and cause segfaults if you don't know about the Ref / RefMut / (none) postfixes of the types. Therefore this should very clearly be documented so you don't miss it.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Bindings entry points and trace how the Ref, RefMut, and no-postfix type forms are exposed. Document the move semantics and the misuse cases that can cause segfaults, with wording clear enough that users do not overlook the distinction.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.