rust-windowing / rust-windowing/softbuffer

Consider design of error type(s)

Open
#73 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Needs Design Work
Dominant language
Rust
Stars
506
Forks
85
PR merge metrics
No merged PRs in 30d

Description

  • What variants are useful to provide? What errors might a consumer of the library want to actually handle?
  • Some error variants may only apply to certain methods. Should the same error type be used everywhere, or might it be helpful to have more than one?
  • The x11 code currently has a swbuf_err helper method. Any helpers like this should be in error.rs and used in other backends where it's useful.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing x11 code, especially the swbuf_err helper, and inspect error.rs. Compare the error cases across methods and backends, then document the proposed error variants and whether helpers belong in error.rs. Done means the error API design is agreed and the relevant helpers are consistently placed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.