Skip to content

Upgrade build for modern RDKit + Rust 2024 + AtomRef#50

Open
sharifhsn wants to merge 13 commits intordkit-rs:mainfrom
sharifhsn:pr/build-modernization
Open

Upgrade build for modern RDKit + Rust 2024 + AtomRef#50
sharifhsn wants to merge 13 commits intordkit-rs:mainfrom
sharifhsn:pr/build-modernization

Conversation

@sharifhsn
Copy link

@sharifhsn sharifhsn commented Mar 15, 2026

Summary

This PR fixes the build for modern RDKit (2024.09+) and modernizes the Rust toolchain.

Build fixes:

  • C++17 → C++20 (RDKit 2024.09+ uses constexpr virtual destructors)
  • Rust edition 2021 → 2024, with tail-expression drop order fix
  • Fix clippy warnings, update rustfmt.toml to use style_edition
  • Update cxx, bitvec, thiserror to latest versions
  • Fix broken rdkit-sys link in README

New feature — AtomRef for read-only atom access:

Currently, reading atom properties requires &mut self:

// Today: needs mutable borrow even for read-only access
let mut mol = ROMol::from_smiles("CCO").unwrap();
let atom = mol.atom_with_idx(0); // &mut self
println!("{}", atom.symbol());

AtomRef adds a const FFI path so read-only access uses &self:

let mol = ROMol::from_smiles("CCO").unwrap();
let atom = mol.atom_ref(0); // &self — no mut needed
println!("{}", atom.symbol());

PRs #51#54 build on this branch and add bond access, fingerprints, descriptors, and conformers.

🤖 Generated with Claude Code

sharifhsn and others added 13 commits March 13, 2026 22:37
RDKit 2025.09.x uses constexpr virtual destructors and override
functions in its headers (e.g. Geometry/point.h), which require
C++20. Building with -std=c++17 causes compilation failures.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Fixes mismatched_lifetime_syntaxes warning by making the elided
lifetime on Atom<'_> explicit, matching the &mut self borrow.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove unused lifetime parameter 'a from PeriodicTableOps impl,
and replace names.len() != 0 with !names.is_empty().

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The 'version' key is deprecated in current rustfmt. Replace with
'style_edition = "2021"' in both workspace and rdkit-sys configs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Bind get_periodic_table() to a local variable instead of using it
as a temporary in tail expressions. In Rust 2024, temporaries in
tail expressions are dropped before locals, which would drop the
PeriodicTable UniquePtr before the CxxString it borrows.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update edition to 2024 in both Cargo.toml files and rustfmt configs.
Apply 2024 style formatting: types before functions/macros in imports,
and long assert_eq! macro calls wrapped across multiple lines.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add get_atom_with_idx_const that takes const shared_ptr<ROMol>& and
returns const Atom&, using RDKit's const overload of getAtomWithIdx.
This maps to Pin<&Atom> in CXX, enabling &self access on the Rust side.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
AtomRef<'a> holds Pin<&'a Atom> (const) and exposes all read-only
atom methods. ROMol::atom_ref(&self) returns AtomRef, eliminating
the need to clone molecules just to read atom properties.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Verify AtomRef returns identical values for all read-only methods,
property getters work, multiple AtomRefs coexist (no &mut needed),
and iteration over all atoms works via &self.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Benchmarks for the featurization hot path with 7 drug-like molecules:
- atom_ref (const, &self): ~7μs for 7 properties across all atoms
- atom_with_idx (&mut self): ~7μs same, but requires &mut
- clone + featurize (&ROMol callers): ~46μs — 6.5x slower due to clone
Shows AtomRef eliminates the clone tax for read-only workflows.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- thiserror 1 -> 2 (derive macro API unchanged for our usage)
- env_logger 0.9/0.10 -> 0.11 (init() API unchanged)
- which 4 -> 8 (which::which() API unchanged)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove inflated clone+featurize and redundant one-property benchmarks.
Keep: atom_ref vs atom_mut (regression guard), clone cost, parse baseline.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
crates.io/crate/ → crates.io/crates/ (missing plural)

Closes rdkit-rs#49

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant