[glennawatson]

What kind of change does this PR introduce?

Feature - new public API on ReactiveUI.Primitives.Reactive.

What is the new behavior?

ReactiveUI.Primitives.Reactive ships ContainerDisposable, a disposal group a System.Reactive consumer can use as a CompositeDisposable.

• ContainerDisposable is a MultipleDisposable that converts implicitly to a CompositeDisposable it owns.
  • Hand it to DisposeWith, to a library that takes a CompositeDisposable, or to your own helper - no conversion at the call site.
  • The conversion is identity-stable, so every conversion of the same container yields the same composite.
  • The composite occupies a slot in the container, so anything registered through it is disposed when the container is. Registering after disposal disposes the registration immediately, matching MultipleDisposable.Add.
  • Clear() and Remove() dispose the composite along with everything else; the next conversion hands back a fresh one, so the container stays usable.
• DisposeWith gains an overload that takes the container. A container is convertible to CompositeDisposable, so without this overload a call site importing both ReactiveUI.Primitives.Reactive and System.Reactive's fluent disposal helpers has two equally-good candidates and does not compile. Taking the container exactly makes this an identity match, which wins outright.

The intended consumer is ReactiveUI.Reactive, whose WhenActivated(Action<MultipleDisposable>) overloads can hand out a ContainerDisposable instead. That is a follow-up in the ReactiveUI repo and is blocked on this shipping - ReactiveUI consumes Primitives as a package reference.

What is the current behavior?

MultipleDisposable ships in ReactiveUI.Disposables, which deliberately has no System.Reactive dependency, so it cannot name CompositeDisposable and no conversion between them exists. Code that gets a MultipleDisposable from WhenActivated and calls System.Reactive's DisposeWith on it does not compile; the workaround is to import ReactiveUI.Primitives.Reactive for the Primitives DisposeWith instead.

Relates to reactiveui/ReactiveUI#4434.

What might this PR break?

None. The change is additive:

• ContainerDisposable is new, and the existing DisposeWith(MultipleDisposable) overload is untouched.
• A container passed to DisposeWith binds to the new overload by identity, so the two overloads coexist whether or not System.Reactive's fluent disposal helpers are also imported.

Two things worth knowing when using it:

• The container's ICollection<IDisposable> view counts the composite as a single entry. Count, Contains and Remove do not see through it to registrations made on the composite.
• Conversion allocates the composite lazily, on first use, and only in the .Reactive flavour.

Checklist

• I have read the Contribute guide
• Tests have been added or updated (for bug fixes / features)
• Docs have been added or updated (for bug fixes / features)
• Changes target the main branch
• PR title follows Conventional Commits

Additional information

The hand-written files are ContainerDisposable.cs, LinqExtensions.ContainerDisposable.cs, ContainerDisposableTests.cs, the added tests in LinqExtensionsTests.cs, and a README paragraph. The rest of the diff is the same two entries repeated across the per-TFM public API baselines.

LinqExtensionsTests.cs now imports System.Reactive.Disposables.Fluent deliberately: that import is what makes the overload-resolution guard a compile-time test rather than a comment.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.15%. Comparing base (72918bd) to head (14d2f4a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #169      +/-   ##
==========================================
+ Coverage   98.14%   98.15%   +0.01%     
==========================================
  Files         703      705       +2     
  Lines       21733    21761      +28     
  Branches     2679     2680       +1     
==========================================
+ Hits        21330    21360      +30     
+ Misses        199      197       -2     
  Partials      204      204              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Nextra]

The lifetimes are only tied in one direction. If the user loses the ContainerDisposable in an accidental implicit conversion, the resulting CompositeDisposable will not dispose all of the containers content. Is that intentional?

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.