aboutsummaryrefslogtreecommitdiff
path: root/cs-dotnet/src/gatsstring.cs
diff options
context:
space:
mode:
Diffstat (limited to 'cs-dotnet/src/gatsstring.cs')
-rw-r--r--cs-dotnet/src/gatsstring.cs16
1 files changed, 16 insertions, 0 deletions
diff --git a/cs-dotnet/src/gatsstring.cs b/cs-dotnet/src/gatsstring.cs
index 3fa3b7e..0935b05 100644
--- a/cs-dotnet/src/gatsstring.cs
+++ b/cs-dotnet/src/gatsstring.cs
@@ -9,6 +9,22 @@ using System.IO;
9 9
10namespace Com.Xagasoft.Gats 10namespace Com.Xagasoft.Gats
11{ 11{
12 /// <summary>
13 /// Encapsulates a single byte array.
14 /// </summary>
15 /// <remarks>
16 /// A GATS string, unlike a C# string primitive, is simply an array of
17 /// bytes. This is actually more flexible in many ways, as it allows a
18 /// GatsString to contain any binary data. However, to encode textual data
19 /// there is no hard and fast standard. If a string primitive is passed
20 /// into a GatsString it will be encoded into UTF-8. If you would rather
21 /// use a different encoding then encode your data first, and then pass it
22 /// in as a byte array.
23 ///
24 /// The ToString implementation provided by GatsString also assumes that
25 /// the contained data is UTF-8 encoded. This may cause some minor issues
26 /// when attempting to debug strings that contain binary.
27 /// </remarks>
12 public class GatsString : GatsObject 28 public class GatsString : GatsObject
13 { 29 {
14 public byte[] Value { get; set; } 30 public byte[] Value { get; set; }