CHANGES.md

Changelog

Version 0.17.0

To be released.

• Removed Dictionary.GetValue<T>() methods. [#122]
• Optimized Encoder.Encode() method. [#124]
• Fixed a bug in Encoder.Encode(IValue, Stream) method. [#124]
• Optimized Encoder.Encode() method. [#125]

Version 0.16.0

Released on October 27th, 2023.

• Removed IValue.Inspection property. [#117]
• Changed IValue.Inspect(bool) to IValue.Inspect(). [#118]
• Removed IEquatable<bool> and IComparable<bool> from Boolean. [#104, #119]
• Added == and != operators for Boolean. [#119]

Version 0.15.0

Released on October 23rd, 2023.

• Removed IEquatable<BigInteger> and IComparable<BigInteger> from Integer. [#104, #107]
• Changed the behaviors of Integer.Equals() and Integer.CompareTo() to be more consistent. [#106, #107]
• Removed IEquatable<string> and IComparable<string> from Text. [#104, #108]
• Removed CompositeComparer<TA, TB> struct. [#109]
• Removed IEquatable<byte[]>, IEquatable<ImmutableArray<byte>>, IComparable<byte[]>, and IComparable<ImmutableArray<byte>> from Binary. [#104, #110]
• Removed IComparer<byte[]> and IComparer<ReadOnlyList<byte>> from ByteArrayComparer. [#110]
• Changed the behaviors of Binary.Equals() and Binary.CompareTo() to be more consistent. [#106, #110]
• Removed ByteArrayComparer and FingerprintComparer. [#111]
• Removed IEquatable<IImmutableList<IValue>> from List. [#104, #112]
• Removed IEquatable<IImmutableDictionary<IKey, IValue>> from Dictionary. [#104, #113]
• Removed Fingerprint struct. [#103, #114]
• Removed IValue.Fingerprint property. [#103, #114]

Version 0.14.0

Released on August 9th, 2023.

• Fixed a bug where a wrongly encoded byte[] could be decoded into an Integer. [#97]
• Optimized decoding Integers both for speed and memory. [#97]
• Optimized for faster decoding on encoded Lists and Dictionarys. [#98]

Version 0.13.0

Released on August 3rd, 2023.

• Removed IOffloadOptions interface and its implementation OffloadOptions class. [#91]
• Removed OffloadingInspector class. [#91]
• Removed IndirectValue class. [#91]
• Changed Codec.Encode() and Codec.Decode() to no longer accept IOffloadOptions as an argument. [#91]
• Optimized for faster decoding on encoded Lists and Dictionarys. [#93]
• Fixed a bug where a wrongly encoded byte[] could be decoded into a Dictionary. [#92, #94]
• Optimized decoding Dictionary's both for speed and memory. [#94]

Version 0.12.0

Released on July 26th, 2023.

• Slightly optimized decoding both for speed and memory. [#86]

Version 0.11.0

Released on July 14th, 2023.

• Slightly optimized encoding both for speed and memory. [#83]

Version 0.10.0

Released on April 20th, 2023.

• Fixed Bencodex.Types.IndirectValue.GetHashCode() to return hash code derived from its content. [#79]

Version 0.9.0

Released on April 19th, 2023.

• Fixed Bencodex.Types.Dictionary.GetHashCode() to return hash code derived from its content. [#72, #76]
• Fixed Bencodex.Types.List.GetHashCode() to return hash code derived from its content. [#72, #76]

Version 0.8.0

Released on January 21st, 2023.

• Added IBencodable interface. [#73]

Version 0.7.0

Released on October 19, 2022.

Since version 0.7.0, project Bencodex.Json is introduced to provide Bencodex JSON Representation.

• Added Bencodex.Types.Binary.FromHex() static method. [#69]
• Added Bencodex.Types.Binary.FromBase64() static method. [#69]
• Added Bencodex.Types.Binary.ToHex() method. [#69]
• Added Bencodex.Types.Binary.ToBase64() method. [#69]
• (Bencodex.Json) a new package named Bencodex.Json is added. [#69]
• (Bencodex.Json) Added BencodexJsonConverter class. [#69]

Version 0.6.0

Released on September 7, 2022.

• Bencodex.Types.List.Add() now directly supports short and ushort types. [#63]
• Bencodex.Types.Dictionary.Add() now directly supports short and ushort types. [#63]
• Bencodex.Types.Dictionary.SetItem() now directly supports Text, Beoolean, Integer, Binary, short, and ushort types. [#64]
• Bencodex.Types.List() now directly supports IEnumerable<T> type parameter where T is Boolean, Integer, Binary, Text, bool, short, ushort, int, uint, long, ulong, byte[], ImmutableArray<byte>, or string. [#65]
• Bencodex.Types.List() now directly supports IEnumerable<KeyValuePair<K, V>> type parameter where K is Binary, Text, byte[], ImmutableArray<byte>, or string and V is Boolean, Integer, Binary, Text, bool, short, ushort, int, uint, long, ulong, byte[], ImmutableArray<byte>, or string. [#65]
• Bencodex.Types.Dictionary.Add() and Bencodex.Types.Dictionary.SetItem() no longer support IEnumerable<IValue> type parameter. [#66]

Version 0.5.0

Released on September 2, 2022.

• Bencodex.Types.List.Add() now directly supports Text, Boolean, Integer, and Binary types. [#58, #60]
• Bencodex.Types.Dictionary.Add() now directly supports Text, Boolean, Integer, and Binary types. [#58, #60]

Version 0.4.0

Released on December 8, 2021.

• Bencodex.Types.List struct became a sealed class. [#51, #52]
• Bencodex.Types.Dictionary readonly struct became a sealed class. [#51, #52]
• Bencocex.Types.List class now implements IEqutable<Bencodex.Types.List> interface. [#52]
• Bencodex.Types.Dictionary class now implements IEquatable<Bencodex.Types.Dictionary> interface. [#51]
• Added Bencodex.Types.ValueKind enum type. [#50, #53]
• Bencodex lists and dictionaries now can offload their elements:
  • Added Codec.Encode(IValue, IOffloadOptions?) overloaded method. [#55]
  • Added Codec.Encode(IValue, Stream, IOffloadOptions?) overloaded method. [#55]
  • Added Codec.Decode(byte[], IndirectValue.Loader?) overloaded method. [#55]
  • Added Codec.Decode(Stream, IndirectValue.Loader?) overloaded method. [#55]
  • Added Bencodex.Types.IndirectValue struct. [#52]
  • Added List(IEnumerable<IndirectValue>, IndirectValue.Loader) constructor. [#52]
  • Added Dictionary(IEnumerable<KeyValuePair<IKey, IndirectValue>>, IndirectValue.Loader) constructor. [#52]
  • Added Bencodex.IOffloadOptions interface. [#55]
  • Added Bencodex.OffloadOptions sealed class. [#55]
  • Added Bencodex.OffloadingInspector static class. [#56]
• Bencodex values now have their unique fingerprints: [#50]
  • Added Bencodex.Types.Fingerprint readonly struct.
  • Added Bencodex.Misc.FingerprintComparer class.
  • Added IValue.Fingerprint property.
  • Added Null.SingletonFingerprint static readonly field.
  • Added Boolean.TrueFingerprint static readonly field.
  • Added Boolean.FalseFingerprint static readonly field.
  • Added List.EmptyFingerprint static readonly field.
  • Added Dictionary.EmptyFingerprint static readonly field.
• Added IValue.Kind property. [#50, #53]
• Added IValue.EncodingLength property. [#49, #50]
• Added IValue.Inspect(bool) method to replace IValue.Inspection property. [#52]
• Added Bencodex.Misc.ImmutableByteArrayExtensions static class. [#50]
• Replaced Binary(byte[]) constructor with Binary(params byte[]) constructor. [#50]
• Added List(params IValue[]) constructor. [#51]
• Added Bencodex.Types.Dictionary[Text] indexer. [#52]
• Added Bencodex.Types.Dictionary[Binary] indexer. [#52]
• Added Bencodex.Types.Dictionary.ContainsKey(Text) method. [#52]
• Added Bencodex.Types.Dictionary.ContainsKey(Binary) method. [#52]
• Added Bencodex.Misc.KeyComparer class. [#51]
• List.Empty static property became a static readonly field. [#50]
• Dictionary.Empty static property became a static readonly field. [#50]
• Deprecated IValue.Inspection property in favor of IValue.Inspect(bool) method. [#52]
• Removed IValue.EncodeToStream() method. [#54]
• Removed IValue.EncodeIntoChunks() method. [#54]
• Removed IKey.EncodeAsByteArray() method. [#54]
• Removed IKey.KeyPrefix property. [#54]
• Removed Bencodex.Types.List.Value property. [#52]
• Removed Bencodex.Types.CommonVariables static class. [#50]

Version 0.3.0

Released on October 5, 2021.

• The package became to have an assembly for .NET Standard 2.1 besides an existing assembly for .NET Standard 2.0. The new assembly purposes to support nullable reference types. [#24]
• IValue interface became to inherit IEquatable<IValue>. [#19]
• Bencodex.Types.Null became a read-only struct. [#37]
• Added Bencodex.Types.Null.Value read-only field. [#20, #37]
• Bencodex.Types.Binary's internal representation became ImmutableArray<byte> instead of byte[]. [#39]
  • Binary became to implement IEquatable<ImmutableArray<byte>>.
  • Binary became to implement IComparer<ImmutableArray<byte>>.
  • Added Binary(ImmutableArray<byte>) constructor.
  • Binary.Value property became obsolete.
  • Added Binary.ByteArray property.
  • Added Binary.ToByteArray() method.
• Bencodex.Types.Dictionary became a read-only struct. [#24]
• Bencodex.Types.Dictionary(IEnumerable<KeyValuePair<IKey, IValue>>) constructor now has no default value for the parameter. [#24]
• Bencodex.Types.Dictionary.SetItem() became to have more overloads. Added overloads, which is listed below, return Bencodex.Types.Dictionary instead of IImmutableDictionary<IKey, IValue>. Note that existing SetItem(IKey, IValue) method which implements IImmutableDictionary<IKey, IValue> is still remained as it had been. [#7, #40]
  • (IKey, string) [#7]
  • (IKey, ImmutableArray<byte>) [#40]
  • (IKey, byte[]) [#7]
  • (IKey, long) [#7]
  • (IKey, ulong) [#7]
  • (IKey, bool) [#7]
  • (IKey, IEnumerable<IValue>) [#7]
  • (string, IValue) [#7]
  • (string, string) [#7]
  • (string, ImmutableArray<byte>) [#40]
  • (string, byte[]) [#7]
  • (string, long) [#7]
  • (string, ulong) [#7]
  • (string, bool) [#7]
  • (string, IEnumerable<IValue>) [#7]
  • (ImmutableArray<byte>, IValue) [#7]
  • (ImmutableArray<byte>, string) [#7]
  • (ImmutableArray<byte>, ImmutableArray<byte>) [#40]
  • (ImmutableArray<byte>, byte[]) [#7]
  • (ImmutableArray<byte>, long) [#7]
  • (ImmutableArray<byte>, ulong) [#7]
  • (ImmutableArray<byte>, bool) [#7]
  • (ImmutableArray<byte>, IEnumerable<IValue>) [#7]
  • (byte[], IValue) [#7]
  • (byte[], string) [#7]
  • (byte[], ImmutableArray<byte>) [#40]
  • (byte[], byte[]) [#7]
  • (byte[], long) [#7]
  • (byte[], ulong) [#7]
  • (byte[], bool) [#7]
  • (byte[], IEnumerable<IValue>) [#7]
• Bencodex.Types.Dictionary.Add() became to have more overloads. Added overloads, which is listed below, return Bencodex.Types.Dictionary instead of IImmutableDictionary<IKey, IValue>. Note that existing Add(IKey, IValue) method which implements IImmutableDictionary<IKey, IValue> is still remained as it had been. [#7, #40]
  • (string, IValue) [#7]
  • (string, string) [#7]
  • (string, ImmutableArray<byte>) [#40]
  • (string, byte[]) [#7]
  • (string, long) [#7]
  • (string, ulong) [#7]
  • (string, bool) [#7]
  • (string, IEnumerable<IValue>) [#7]
  • (ImmutableArray<byte>, IValue) [#40]
  • (ImmutableArray<byte>, string) [#40]
  • (ImmutableArray<byte>, ImmutableArray<byte>) [#40]
  • (ImmutableArray<byte>, byte[]) [#40]
  • (ImmutableArray<byte>, long) [#40]
  • (ImmutableArray<byte>, ulong) [#40]
  • (ImmutableArray<byte>, bool) [#40]
  • (ImmutableArray<byte>, IEnumerable<IValue>) [#40]
  • (byte[], IValue) [#7]
  • (byte[], string) [#7]
  • (byte[], byte[]) [#7]
  • (byte[], ImmutableArray<byte>) [#40]
  • (byte[], long) [#7]
  • (byte[], ulong) [#7]
  • (byte[], bool) [#7]
  • (byte[], IEnumerable<IValue>) [#7]
• Added Bencodex.Types.Dictionary[string] indexer. [#7]
• Added Bencodex.Types.Dictionary[ImmutableArray<byte>] indexer. [#40]
• Added Bencodex.Types.Dictionary[byte[]] indexer. [#7]
• Added Bencodex.Types.Dictionary.Empty static property. [#7]
• Added Bencodex.Types.Dictionary.GetValue<T>(string) method. [#7]
• Added Bencodex.Types.Dictionary.GetValue<T>(ImmutableArray<byte>) method. [#40]
• Added Bencodex.Types.Dictionary.GetValue<T>(byte[]) method. [#11]
• Bencodex.Types.Dictionary.TryGetKey() became to fill its out parameter with an empty Binary value when it returns false. [#24]
• Bencodex.Types.Dictionary.TryGetValue() became to fill its out parameter with a Bencodex.Types.Null value when it returns false. [#24]
• Added IValue.Inspection property to get a JSON-like human-readable representation for the sake of debugging. [#12, #13]
• ToString() method of IValue subclasses became to return its Inspection with a prefix of the qualified class name. [#12, #13]
• Binary became a read-only struct. [#14]
• Added Binary(string, System.Text.Encoding) constructor. [#14]
• Fixed a bug that changing on an array returned by Binary.Value property had changed the Binary as well. Binary.Value property became to return always a new copy of its internal array. [#14]
• Added overloads to Bencodex.Types.Dictionary.ContainsKey() for the sake of convenience. [#15, #40]
  • Bencodex.Types.Dictionary.ContainsKey(string) [#15]
  • Bencodex.Types.Dictionary.ContainsKey(ImmutableArray<byte>) [#40]
  • Bencodex.Types.Dictionary.ContainsKey(byte[]) [#15]
• Bencodex.Types.Integer(string value) constructor was replaced by Bencodex.Types.Integer(string value, IFormatProvider? provider = null) which is still compatible in source code level. [#23]
• Fixed encoding and decoding bugs that had been occurred on some locales writing RTL scripts, e.g., Arabic (ar). [#23]
• Added Bencodex.Types.List[int] indexer. [#25]
• Added Bencodex.Types.List.Count property. [#25]
• Bencodex.Types.List.Add() became to have more overloads, which return Bencodex.Types.List so that it is convenient to chain method calls. [#26]
  • Add(IValue)
  • Add(string)
  • Add(byte[])
  • Add(bool)
  • Add(BigInteger)
• Added Bencodex.Types.List.Empty static property. [#26]
• Removed Bencodex.Misc.ByteChunkQueue class. [#28]
• Codec.Decode() method was entirely rewritten to optimize. [#28]
• Optimized Bencodex.Types.Binary.GetHashCode() method. Now the hash code is calculated using the modified FNV, and cached after it is once calculated. [#28]
• Added IValue.EncodeToStream(Stream) method. [#32]
• Bencodex.Types.Dictionary became not to immediately realize the inner hash table, but do it when it needs (e.g., when to look up a key) instead. Note that this change does not cause any API changes, but just purposes faster instantiation. [#33, #34]
• Bencodex.Misc.ByteArrayComparer now implements IComparer<ImmutableArray<byte>> besides IComparer<byte[]>. [#39]

Version 0.2.0

Released on October 30, 2019.

• Relicensed under LGPL 2.1 or later.
• Added more implicit conversions. [#1]
  • Integer ↔ short
  • Integer ↔ ushort
  • Integer → int
  • Integer ↔ uint
  • Integer ↔ long
  • Integer ↔ ulong
  • Binary → bytes
  • Boolean ↔ bool

Version 0.1.0

Released on December 17, 2018.

• Implemented the specification version 1.