Collection ToString, ToFullString, ToFullArrayString

louthy · Jan 12, 2020 · 2cc42b4 · 2cc42b4
1 parent d0f5eaa
commit 2cc42b4
Show file tree

Hide file tree

Showing 16 changed files with 456 additions and 16 deletions.
diff --git a/LanguageExt.Core/DataTypes/Arr/Arr.cs b/LanguageExt.Core/DataTypes/Arr/Arr.cs
@@ -455,6 +455,30 @@ public IEnumerable<A> AsEnumerable() =>
         public Seq<A> ToSeq() =>
             Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         [Pure]
         public IEnumerable<A> Skip(int amount) =>
             Value.Skip(amount);

diff --git a/LanguageExt.Core/DataTypes/HashMap/HashMap.Eq.cs b/LanguageExt.Core/DataTypes/HashMap/HashMap.Eq.cs
@@ -621,6 +621,30 @@ IEnumerator IEnumerable.GetEnumerator() =>
         public Seq<(K Key, V Value)> ToSeq() =>
             Seq(Value.AsEnumerable());
 
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"), Count);
+
+        /// <summary>
+        /// Format the collection as `(key: value), (key: value), (key: value), ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"));
+
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"));
+
         [Pure]
         public IEnumerable<(K Key, V Value)> AsEnumerable() =>
             Value.AsEnumerable();

diff --git a/LanguageExt.Core/DataTypes/HashMap/HashMap.cs b/LanguageExt.Core/DataTypes/HashMap/HashMap.cs
@@ -646,6 +646,30 @@ IEnumerator IEnumerable.GetEnumerator() =>
         public Seq<(K Key, V Value)> ToSeq() =>
             Seq(AsEnumerable());
 
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"), Count);
+
+        /// <summary>
+        /// Format the collection as `(key: value), (key: value), (key: value), ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"));
+
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"));
+
         [Pure]
         public IEnumerable<(K Key, V Value)> AsEnumerable() =>
             Value;

diff --git a/LanguageExt.Core/DataTypes/HashSet/HashSet.Eq.cs b/LanguageExt.Core/DataTypes/HashSet/HashSet.Eq.cs
@@ -392,6 +392,30 @@ IEnumerator IEnumerable.GetEnumerator() =>
         public Seq<A> ToSeq() =>
             Prelude.Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         [Pure]
         public IEnumerable<A> AsEnumerable() =>
             this;

diff --git a/LanguageExt.Core/DataTypes/HashSet/HashSet.cs b/LanguageExt.Core/DataTypes/HashSet/HashSet.cs
@@ -381,6 +381,30 @@ IEnumerator IEnumerable.GetEnumerator() =>
         public Seq<A> ToSeq() =>
             Prelude.Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         [Pure]
         public IEnumerable<A> AsEnumerable() =>
             this;

diff --git a/LanguageExt.Core/DataTypes/List/Lst.Predicate.cs b/LanguageExt.Core/DataTypes/List/Lst.Predicate.cs
@@ -245,6 +245,30 @@ IEnumerator<A> IEnumerable<A>.GetEnumerator() =>
         public Seq<A> ToSeq() =>
             Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         [Pure]
         public IEnumerable<A> AsEnumerable() =>
             this;

diff --git a/LanguageExt.Core/DataTypes/List/Lst.Predicate2.cs b/LanguageExt.Core/DataTypes/List/Lst.Predicate2.cs
@@ -177,6 +177,30 @@ public IEnumerator<A> GetEnumerator() =>
         public Seq<A> ToSeq() =>
             Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         [Pure]
         public IEnumerable<A> AsEnumerable() =>
             this;

diff --git a/LanguageExt.Core/DataTypes/List/Lst.cs b/LanguageExt.Core/DataTypes/List/Lst.cs
@@ -302,6 +302,30 @@ IEnumerator<A> IEnumerable<A>.GetEnumerator() =>
         public Seq<A> ToSeq() =>
             Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         [Pure]
         public IEnumerable<A> AsEnumerable() =>
             this;

diff --git a/LanguageExt.Core/DataTypes/Map/Map.Ord.cs b/LanguageExt.Core/DataTypes/Map/Map.Ord.cs
@@ -623,6 +623,31 @@ IEnumerator IEnumerable.GetEnumerator() =>
         public Seq<(K Key, V Value)> ToSeq() =>
             Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(ValueTuples.Map(kv => $"({kv.Key}: {kv.Value})"), Count);
+
+        /// <summary>
+        /// Format the collection as `(key: value), (key: value), (key: value), ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(ValueTuples.Map(kv => $"({kv.Key}: {kv.Value})"));
+
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(ValueTuples.Map(kv => $"({kv.Key}: {kv.Value})"));
+
+
         [Pure]
         public IEnumerable<(K Key, V Value)> AsEnumerable() => 
             Value.AsEnumerable();

diff --git a/LanguageExt.Core/DataTypes/Map/Map.cs b/LanguageExt.Core/DataTypes/Map/Map.cs
@@ -658,6 +658,30 @@ IEnumerator IEnumerable.GetEnumerator() =>
         public Seq<(K Key, V Value)> ToSeq() =>
             Seq(this);
 
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            CollectionFormat.ToShortArrayString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"), Count);
+
+        /// <summary>
+        /// Format the collection as `(key: value), (key: value), (key: value), ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"));
+
+        /// <summary>
+        /// Format the collection as `[(key: value), (key: value), (key: value), ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(AsEnumerable().Map(kv => $"({kv.Key}: {kv.Value})"));
+
         [Pure]
         public IEnumerable<(K Key, V Value)> AsEnumerable() => 
             Value.AsEnumerable();

diff --git a/LanguageExt.Core/DataTypes/Seq/Seq.cs b/LanguageExt.Core/DataTypes/Seq/Seq.cs
@@ -678,6 +678,32 @@ public override int GetHashCode() =>
                 ? hash(this)
                 : hash;
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
+        [Pure]
+        public override string ToString() =>
+            Value is SeqLazy<A>
+                ? CollectionFormat.ToShortArrayString(this)
+                : CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
+
         /// <summary>
         /// Append operator
         /// </summary>

diff --git a/LanguageExt.Core/DataTypes/Set/Set.cs b/LanguageExt.Core/DataTypes/Set/Set.cs
@@ -577,9 +577,29 @@ obj is Set<A> &&
         public override int GetHashCode() =>
             Value.GetHashCode();
 
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// The elipsis is used for collections over 50 items
+        /// To get a formatted string with all the items, use `ToFullString`
+        /// or `ToFullArrayString`.
+        /// </summary>
         [Pure]
         public override string ToString() =>
-            $"Set[{Count}]";
+            CollectionFormat.ToShortArrayString(this, Count);
+
+        /// <summary>
+        /// Format the collection as `a, b, c, ...`
+        /// </summary>
+        [Pure]
+        public string ToFullString(string separator = ", ") =>
+            CollectionFormat.ToFullString(this);
+
+        /// <summary>
+        /// Format the collection as `[a, b, c, ...]`
+        /// </summary>
+        [Pure]
+        public string ToFullArrayString(string separator = ", ") =>
+            CollectionFormat.ToFullArrayString(this);
 
         [Pure]
         public Seq<A> ToSeq() =>