[C#,Unity] HashSet が ReadOnlyCollectionで使用できない

Question

実現したいこと

HashSet を ReadOnlyCollectionで返すメソッドはどのように実装すべきでしょうか。

発生している問題・分からないこと

Listを読み取り専用形式で取得するReadOnlyCollectionをHashSetでも使用したいのですが下記のようにコンパイルエラーが発生してしまいます。

HashSetでReadOnlyCollectionを用いるにはどうすればよいでしょうか？

エラーメッセージ

コンパイルエラーメッセージ：シンボルAsReadOnlyを解決できません

該当のソースコード

private List<int> intList = new List<int>();
        
        public ReadOnlyCollection<int> GetIntList()
        {
            return intList.AsReadOnly();
        }
        
        private HashSet<int> intHashSet = new HashSet<int>();
        
        public ReadOnlyCollection<int> GetHashSet()
        {
            return intHashSet.AsReadOnly();
        }
        

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

解決方法が見つかりませんでした

補足

特になし

Comments

[lehshell]

Lsit 経由か配列経由では何か問題があるのでしょうか？
using System.Linq;
return intHashSet.ToList().AsReadOnly();
return new ReadOnlyCollection<int>(intHashSet.ToArray());

[ko_yu]

渡す時はHashSetではなくListにキャストして渡すということでしょうか。
用途としてはそちらで十分なのですが、元がHashSetなのでできればHashSetで渡したいのと、同じCollectionなのになぜHashSetにはAsReadOnlyが無いのか気になります

[juner]

@Iehshell `ReadOnlyCollection<T>` は 生の List<T> インスタンスに 読み取り専用 インターフェスだけの wrapper を生やすクラスな為、`ReadOnlyCollection<T>` の List<T> への変更に追従する の利点が完全に死ぬ為 あまりよくないのでは？感あります。

Answer 1

ReadOnlyCollection ではなく 読み取り専用であればいいの ニュアンスでしたら IList<T> に依存した ReadOnlyCollection<T> ではなく ReadOnlySet<T> を使った方がいいのではないでしょうか？

ReadOnlyCollection<T> クラス (System.Collections.ObjectModel) | Microsoft Learn

ReadOnlySet<T> クラス (System.Collections.ObjectModel) | Microsoft Learn

そうすれば 実装も読み取り専用になりますし、 読み取り専用インターフェスの IReadOnlyCollection<T> も使えます。

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
{
    List<int> intList = [1,2,3,4,5];
    var r = intList.AsReadOnly();
    IReadOnlyCollection<int> r2 = r;
    Console.WriteLine(r2.GetType());
    Console.WriteLine(string.Join(", ",r2));
    intList.Add(6);
    Console.WriteLine(string.Join(", ",r2));
}
{
    HashSet<int> intList = [1,2,3,4,5];
    var r = new ReadOnlySet<int>(intList);
    IReadOnlyCollection<int> r2 = r;
    Console.WriteLine(r2.GetType());
    Console.WriteLine(string.Join(", ",r2));
    intList.Add(6);
    Console.WriteLine(string.Join(", ",r2));
}

System.Collections.ObjectModel.ReadOnlyCollection`1[System.Int32]
1, 2, 3, 4, 5
1, 2, 3, 4, 5, 6
System.Collections.ObjectModel.ReadOnlySet`1[System.Int32]
1, 2, 3, 4, 5
1, 2, 3, 4, 5, 6

sharplab

追伸

ただ、ReadOnlySet<T> は .NET 9 からで、 Unity は .NET 9 にまだ対応していない為、やるのであれば IReadOnlyCollection<int> へのキャストが一番無難な気もします。（ただし、利用側が HashSet<T> にダウンキャストすると書き込み可能なことに注意は必要だが、自分でやるだけならそれでも問題は無い

追伸の追伸

もしも HashSet<T> ではなくて ISet<T> でもよいのであれば ImmutableHashSet<T> を使うのも手です。

using System;
using System.Collections.Immutable;

ImmutableHashSet<int> hashSet = [1,2,3,4,5];
Console.WriteLine($"hashSet: {string.Join(", ",hashSet)}");
var newHashSet = hashSet.Add(6);
Console.WriteLine($"hashSet: {string.Join(", ",hashSet)}");
Console.WriteLine($"newHashSet: {string.Join(", ",newHashSet)}");

hashSet: 1, 2, 3, 4, 5
hashSet: 1, 2, 3, 4, 5
newHashSet: 1, 2, 3, 4, 5, 6

sharplab

https://learn.microsoft.com/ja-jp/dotnet/api/system.collections.immutable.immutablehashset-1?view=net-8.0

Comments

[ko_yu]

回答ありがとうございます！
なかなか使い勝手が良さそうなReadOnlySetですが、Unityではまだ使えないのですね。

用途としては他クラスが取得できるようにしたHashSetを渡す際にAsReadOnlyにして参照はできても変更はできないようにしたかったのですが、現状はListへのキャストが無難そうですね。

[juner]

いえ、 `List<T>` への変換（=HashSet<T> から列挙してList<T> に詰めなおし）ではなくて `IReadOnlyCollection<T>` であれば キャストコストだけ ですよ……？くらいのニュアンス（使う側が元の型へキャストしないかぎりは書き込みできないので

[ko_yu]

public IReadOnlyCollection<int> GetHashSet()
{
return intHashSet();
}

すみません、お返事遅くなってしまいました。
これを取得先で各自キャストしてもらうということでしょうか？

[juner]

いえ、 IReadOnlyCollection<T> の必要が無いなら HashSet<T> を そのまま返せばいいニュアンスです。 IReadOnlyCollection の必要になる場合だけキャストしておけばいい感じです。
もしも ISet<T> であればいいのであれば ImmutableHashSet<T> を使うのも手です。
https://learn.microsoft.com/ja-jp/dotnet/api/system.collections.immutable.immutablehashset-1?view=net-8.0