rust-lang / rust-lang/libs-team

Decide the intended relationship between `core::$module`, `alloc::$module`, `std::$module`

Open
#434 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
178
Forks
28
Avg merge
15m
Merged PRs (30d)
1

Description

All of the following designs are in use for various standard library modules:

  1. core::$modulealloc::$modulestd::$module
  2. core::$modulealloc::$module = ∅, (core::$modulealloc::$module) ⊆ std::$module
  3. something else, intentionally
  4. something else, unintentionally

Is one of these a good design that should ideally be getting applied for all modules?

design 1 core::alloc alloc::alloc std::alloc
Allocator ☑️ ☑️ ☑️
GlobalAlloc ☑️ ☑️ ☑️
Layout ☑️ ☑️ ☑️
Global ☑️ ☑️
alloc ☑️ ☑️
System ☑️
set_alloc_error_hook ☑️
design 2 core::sync alloc::sync std::sync
atomic ☑️ ☑️
Arc ☑️ ☑️
Weak ☑️ ☑️
Mutex ☑️
mpsc ☑️
design 3 core::panic alloc::panic std::panic
Location ☑️ ☑️
UnwindSafe ☑️ ☑️
PanicInfo ☑️ deprecated
PanicMessage ☑️
PanicHookInfo ☑️
catch_unwind ☑️
design 4 core::ffi::c_str alloc::ffi::c_str std::ffi::c_str
CStr ☑️ ☑️
FromBytesUntilNulError ☑️ ☑️
FromBytesWithNulError ☑️ ☑️
Bytes (bug?) ☑️
CString ☑️ ☑️
FromVecWithNulError ☑️ ☑️
IntoStringError ☑️ ☑️
NulError ☑️ ☑️

Some other examples where an item in core::$module and/or alloc::$module does not appear in std::$module:

  • core::char::encode_utf8_raw
  • core::char::encode_utf16_raw
  • core::error::Source
  • core::ffi::va_list
  • core::iter::InPlaceIterable
  • core::iter::SourceIter
  • core::iter::TrustedFused
  • core::iter::TrustedRandomAccess
  • core::iter::TrustedRandomAccessNoCoerce
  • core::ops::Receiver
  • core::ptr::Thin
  • core::ptr::Unique
  • core::slice::memchr
  • core::slice::GetManyMutError
  • core::slice::SlicePattern
  • core::str::next_code_point
  • core::str::utf8_char_width
  • core::panicking
  • core::range
  • core::ub_checks
  • core::unicode

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 comparing the listed exports across the core, alloc, and std module entry points, including the alloc, sync, panic, and ffi::c_str examples. Review the remaining examples that are absent from std and use the issue's four designs to frame the discussion; done requires an agreed intended relationship, not an implementation patch.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.