Add IReadOnlySet<T> interface #32488

Jlalond · 2020-02-18T15:00:59Z

Jlalond · 2020-02-18T15:09:40Z

@stephentoub Sorry about the naming/rebasing, I dropped when I should've squashed and got myself into trouble. The dangers of not drinking coffee early in the morning

src/libraries/System.Collections/src/System/Collections/Generic/HashSet.cs

Jlalond · 2020-02-20T23:02:45Z

@danmosemsft / @jkotas It's not mentioned in the issue, but should we have IImmutableSet<T> inherit from IReadOnlySet<T> instead of having Immutable hashset/sortedset inherit from IReadOnlySet individually?

maryamariyan · 2020-02-24T18:33:42Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

Jlalond · 2020-02-25T02:08:53Z

@maryamariyan So I should add to the dev remarks? Even if I haven't actually added a method to the ref/impl

jkotas · 2020-02-25T14:27:29Z

@eiriktsarpalis @layomia You are the area-System.Collections owners according to https://github.com/dotnet/runtime/blob/master/docs/area-owners.md. Could you please provide guidance to @Jlalond with this PR?

carlossanlop · 2020-02-25T17:25:24Z

So I should add to the dev remarks? Even if I haven't actually added a method to the ref/impl

@Jlalond You are adding the interface only in the src file. Shouldn't new interfaces be added to ref files as well so they can be exposed publicly?

Yes, please add triple slash comments on top of the interface's type and methods.

We have new official guidance, and not having documentation for new APIs is considered a PR merge blocker.

Jlalond · 2020-02-25T18:28:12Z

@carlossanlop I understand that I needed to add this to ref and impl and I did that for hashset and sortedset, as well as their respective ref/impl in Immutable. Is there a ref for private core lib? Because if so, it all makes sense to me now as to why I'm struggling to get this to build. I will add the dev comments for certain, but I wanted to clear up where I'm not implementing in a ref vs an impl

carlossanlop · 2020-02-25T18:33:37Z

Is there a ref for private core lib? Because if so, it all makes sense to me now as to why I'm struggling to get this to build.

@jkotas @eiriktsarpalis @layomia do you know in which ref file this interface should be declared?

Jlalond · 2020-02-25T18:34:58Z

@carlossanlop I think I found it in System.Runtime, sorry it took me so long to figure that out :(

carlossanlop · 2020-02-25T18:53:19Z

No worries, @Jlalond 😸 Glad you found it.

Jlalond · 2020-02-25T21:16:36Z

@carlossanlop macosx runtime seemed to fail, are there any flaky tests/can you bump the build one more time?

Looks it failed twice for crypto

eiriktsarpalis · 2020-02-26T12:20:43Z

src/libraries/System.Private.CoreLib/src/System/Collections/Generic/IReadOnlySet.cs

+        /// Determines whether the current set overlaps with the specified collection.
+        /// </summary>
+        /// <param name="other">The collection to compare to the current set.</param>
+        /// <returns>ture if the currnet set and other share at least one common eleemnt; otherwise, false.</returns>


Suggested change

/// <returns>ture if the currnet set and other share at least one common eleemnt; otherwise, false.</returns>

/// <returns><see langword="true" />if the current set and other share at least one common element; otherwise, <see langword="false" />.</returns>

@eiriktsarpalis I made a tiny edit to your suggestion.

@carlossanlop should I apply these langwords to all instances of true/false while I'm at it?

Yes sure, that would be great, thank you. true, false and also null.

eiriktsarpalis · 2020-02-26T12:33:41Z

@danmosemsft / @jkotas It's not mentioned in the issue, but should we have IImmutableSet inherit from IReadOnlySet instead of having Immutable hashset/sortedset inherit from IReadOnlySet individually?

I think it would be a reasonable and useful addition, but it probably needs to go through api review, since it was not scoped in the original proposal. What say you @terrajobst?

stephentoub · 2020-02-26T16:06:52Z

should we have IImmutableSet inherit from IReadOnlySet

I think it would be a reasonable and useful addition

Wouldn't that be a breaking change?

Jlalond · 2020-02-26T23:24:11Z

@stephentoub Can you explain why you think it's a breaking change? Is it because the old call sites would now be defined by an interface?

stephentoub · 2020-02-27T01:32:44Z

e.g. as a source breaking change example, imagine you have this:

interface A { void Bar(); }
    
public class C : A
{
    void A.Bar() { }
}

Now I come along and add:

interface B { void Bar(); }

and change A to inherit B. C will no longer compile.

Jlalond · 2020-02-27T02:00:18Z

@stephentoub Makes absolute sense, as which method to call, I only ask because IImmutableSet only inherits from IReadOnlyCollection. I'm absolutely no expert on this, just wanting to learn.

To clarify what I mean, In your above example, only C is defining Bar() and now is inheriting the declaration of same function from B, is that still a source breaking change?

stephentoub · 2020-02-27T03:17:51Z

To clarify what I mean, In your above example, only C is defining Bar() and now is inheriting the declaration of same function from B, is that still a source breaking change?

Sorry, I don't understand the question. Can you write out the code for what you're asking?

Jlalond · 2020-02-27T03:26:06Z

@stephentoub
IImmutableSet<T> already exposes contain, and ImmutableHashSet<T> implements both IImmutableSet<T> and ISet<T> which both share contain. This change has ImmutableHashSet<T> inheriting functions from IReadOnlySet<T> which overlaps with ISet<T>. Is having IImmutableSet<T> forwarding the behavior from IReadOnlySet<T> which IImmutableSet<T> is already implementing source breaking?

From:

interface IImmutableSet<T>
{
  bool Contains(T item);
}

To:

interface IImmutableSet<T> : IReadOnlySet<T>
{
   // contains is now defined in read only set
}

stephentoub · 2020-02-27T15:27:33Z

is already implementing source breaking?

Yes. Try it:
https://sharplab.io/#v2:EYLgxg9gTgpgtADwGwBYA+ABATARgLABQGAzAATakDCpIpAknQLaMCuALgIbAA2MAyjDYAeAJYA7NgD5CAb0KkFpYBAjd6TVpx79BoiZIB0lCBI7iAzgApxbUiLYxGASlIBeSaTZQWMANyEAX0JCGxgoADMOMBh1ZnYuXgFhABVpAjkCBWVVKhNOC0tkuwdnfwIgghCJMMjo+gAlGA4AEwB5MW4ATyShVNl5JRU1Y1MCovtHJzKAoA==

Jlalond · 2020-02-28T14:54:51Z

@stephentoub Awesome, thank you for explaining. So we're not adding to IImmutableSet? If so I'll get all the edits done

terrajobst · 2020-02-28T19:45:18Z

@eiriktsarpalis

I think it would be a reasonable and useful addition, but it probably needs to go through api review, since it was not scoped in the original proposal. What say you @terrajobst?

It's listed on the API review feedback already. It's unfortunate that the other immutable interfaces all extend their read-only counterparts because we can't do that for the new IReadOnlySet<T> because it's a breaking change (same reason why the mutable interfaces weren't updated to extend the read-only ones).

I think we should still implement IReadOnlySet<T> on ImmutableHashSet<T> and ImmutableSortedSet<T> though.

Added to immutable set and spec Spacing for Spec Drop code snippets that I re-added accidentally during rebase Re add code snippets that I dropped instead of squashed

Jlalond · 2020-03-03T02:29:33Z

@eiriktsarpalis @layomia Hey guys, rebased on top of master and looks like it's building. If I could get another review I'd appreciate it!

eiriktsarpalis

LGTM, thank you for your contribution.

Jlalond · 2020-03-03T14:22:46Z

@eiriktsarpalis No thank you! Without help of you, Joe and @carlossanlop I wouldn't have figured I needed a ref in System.Runtime!

oliverjanik · 2020-05-01T08:52:54Z

What release will this PR make it into?

eiriktsarpalis · 2020-05-05T12:16:35Z

What release will this PR make it into?

It should already be available in some of the .NET 5 previews. I run preview 5 on my machine and it's there.

nawfalhasan · 2020-06-03T07:15:27Z

Finally... 👏👏

May I suggest Dictionary.KeyCollection should also implement this?

stephentoub changed the title ~~Readonly set~~ Add IReadOnlySet<T> interface Feb 18, 2020

Jlalond force-pushed the readonly-set branch 2 times, most recently from 0e5ce15 to 91bfff5 Compare February 18, 2020 15:08

jkotas reviewed Feb 18, 2020

View reviewed changes

src/libraries/System.Collections/src/System/Collections/Generic/HashSet.cs Outdated Show resolved Hide resolved

danmoseley added the area-System.Collections label Feb 19, 2020

Jlalond force-pushed the readonly-set branch 2 times, most recently from 513ff7c to c722bdb Compare February 20, 2020 22:57

maryamariyan added the new-api-needs-documentation label Feb 24, 2020

jkotas requested review from eiriktsarpalis and layomia February 25, 2020 14:28

eiriktsarpalis reviewed Feb 26, 2020

View reviewed changes

Jlalond added 13 commits March 1, 2020 17:30

Add read only set interface

cad18aa

Rebase and fix conflicts

5138269

Add Implementations into specs

617734e

Added to immutable set and spec Spacing for Spec Drop code snippets that I re-added accidentally during rebase Re add code snippets that I dropped instead of squashed

Add for sorted set in impl

052034f

Refactor interface declarations, change ifdef for immutable

12e2804

Fix indentation

4475ef3

One more indenting change

feb2226

Add ifdef to spec, re-order interfaces

485cad1

Remove from IImmutablespec

98337de

Replace ISet<T> to immutable hashset spec that was erroneously removed

b5be45c

Add read only set to system.runtime ref

259e7f0

Add comments on IReadOnlySet<T>

ced5660

Add lang words to comments and fix spelling

db9067e

Jlalond force-pushed the readonly-set branch from e67d3dd to db9067e Compare March 1, 2020 22:30

eiriktsarpalis approved these changes Mar 3, 2020

View reviewed changes

eiriktsarpalis merged commit 530b556 into dotnet:master Mar 4, 2020

eiriktsarpalis mentioned this pull request Mar 4, 2020

Please add interface IReadOnlySet and make HashSet, SortedSet implement it #2293

Closed

eiriktsarpalis mentioned this pull request Nov 11, 2020

Add an ISet<T>.AsReadOnly() extension method #29387

Open

ghost locked as resolved and limited conversation to collaborators Dec 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add IReadOnlySet<T> interface #32488

Add IReadOnlySet<T> interface #32488

Jlalond commented Feb 18, 2020 •

edited by stephentoub

Loading

Jlalond commented Feb 18, 2020

Jlalond commented Feb 20, 2020

maryamariyan commented Feb 24, 2020

Jlalond commented Feb 25, 2020 •

edited

Loading

jkotas commented Feb 25, 2020

carlossanlop commented Feb 25, 2020 •

edited

Loading

Jlalond commented Feb 25, 2020

carlossanlop commented Feb 25, 2020 •

edited

Loading

Jlalond commented Feb 25, 2020

carlossanlop commented Feb 25, 2020

Jlalond commented Feb 25, 2020 •

edited

Loading

eiriktsarpalis Feb 26, 2020 •

edited by carlossanlop

Loading

carlossanlop Feb 26, 2020

Jlalond Feb 26, 2020

carlossanlop Feb 27, 2020

eiriktsarpalis commented Feb 26, 2020 •

edited

Loading

stephentoub commented Feb 26, 2020 •

edited

Loading

Jlalond commented Feb 26, 2020

stephentoub commented Feb 27, 2020 •

edited

Loading

Jlalond commented Feb 27, 2020 •

edited

Loading

stephentoub commented Feb 27, 2020

Jlalond commented Feb 27, 2020 •

edited

Loading

stephentoub commented Feb 27, 2020

Jlalond commented Feb 28, 2020

terrajobst commented Feb 28, 2020 •

edited

Loading

Jlalond commented Mar 3, 2020

eiriktsarpalis left a comment

Jlalond commented Mar 3, 2020

oliverjanik commented May 1, 2020

eiriktsarpalis commented May 5, 2020

nawfalhasan commented Jun 3, 2020

	/// <returns>ture if the currnet set and other share at least one common eleemnt; otherwise, false.</returns>
	/// <returns><see langword="true" />if the current set and other share at least one common element; otherwise, <see langword="false" />.</returns>

Add IReadOnlySet<T> interface #32488

Add IReadOnlySet<T> interface #32488

Conversation

Jlalond commented Feb 18, 2020 • edited by stephentoub Loading

Jlalond commented Feb 18, 2020

Jlalond commented Feb 20, 2020

maryamariyan commented Feb 24, 2020

Jlalond commented Feb 25, 2020 • edited Loading

jkotas commented Feb 25, 2020

carlossanlop commented Feb 25, 2020 • edited Loading

Jlalond commented Feb 25, 2020

carlossanlop commented Feb 25, 2020 • edited Loading

Jlalond commented Feb 25, 2020

carlossanlop commented Feb 25, 2020

Jlalond commented Feb 25, 2020 • edited Loading

eiriktsarpalis Feb 26, 2020 • edited by carlossanlop Loading

Choose a reason for hiding this comment

carlossanlop Feb 26, 2020

Choose a reason for hiding this comment

Jlalond Feb 26, 2020

Choose a reason for hiding this comment

carlossanlop Feb 27, 2020

Choose a reason for hiding this comment

eiriktsarpalis commented Feb 26, 2020 • edited Loading

stephentoub commented Feb 26, 2020 • edited Loading

Jlalond commented Feb 26, 2020

stephentoub commented Feb 27, 2020 • edited Loading

Jlalond commented Feb 27, 2020 • edited Loading

stephentoub commented Feb 27, 2020

Jlalond commented Feb 27, 2020 • edited Loading

stephentoub commented Feb 27, 2020

Jlalond commented Feb 28, 2020

terrajobst commented Feb 28, 2020 • edited Loading

Jlalond commented Mar 3, 2020

eiriktsarpalis left a comment

Choose a reason for hiding this comment

Jlalond commented Mar 3, 2020

oliverjanik commented May 1, 2020

eiriktsarpalis commented May 5, 2020

nawfalhasan commented Jun 3, 2020

Jlalond commented Feb 18, 2020 •

edited by stephentoub

Loading

Jlalond commented Feb 25, 2020 •

edited

Loading

carlossanlop commented Feb 25, 2020 •

edited

Loading

carlossanlop commented Feb 25, 2020 •

edited

Loading

Jlalond commented Feb 25, 2020 •

edited

Loading

eiriktsarpalis Feb 26, 2020 •

edited by carlossanlop

Loading

eiriktsarpalis commented Feb 26, 2020 •

edited

Loading

stephentoub commented Feb 26, 2020 •

edited

Loading

stephentoub commented Feb 27, 2020 •

edited

Loading

Jlalond commented Feb 27, 2020 •

edited

Loading

Jlalond commented Feb 27, 2020 •

edited

Loading

terrajobst commented Feb 28, 2020 •

edited

Loading