Rename to KVDocument

ValveResourceFormat · Feb 11, 2024 · b9fc037 · b9fc037
1 parent 78b2d60
commit b9fc037
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/ValveKeyValue/ValveKeyValue.Test/Test Data/apisurface.txt b/ValveKeyValue/ValveKeyValue.Test/Test Data/apisurface.txt
@@ -29,7 +29,7 @@ public class ValveKeyValue.KeyValueException
     public string ToString();
 }
 
-public class ValveKeyValue.KVFile
+public class ValveKeyValue.KVDocument
 {
     public void Add(ValveKeyValue.KVObject value);
     public bool Equals(object obj);
@@ -112,14 +112,14 @@ public sealed enum ValveKeyValue.KVSerializationFormat
 public class ValveKeyValue.KVSerializer
 {
     public static ValveKeyValue.KVSerializer Create(ValveKeyValue.KVSerializationFormat format);
-    public ValveKeyValue.KVFile Deserialize(System.IO.Stream stream, ValveKeyValue.KVSerializerOptions options);
+    public ValveKeyValue.KVDocument Deserialize(System.IO.Stream stream, ValveKeyValue.KVSerializerOptions options);
     public ValveKeyValue.TObject Deserialize<ValveKeyValue.TObject>(System.IO.Stream stream, ValveKeyValue.KVSerializerOptions options);
     public bool Equals(object obj);
     protected void Finalize();
     public int GetHashCode();
     public Type GetType();
     protected object MemberwiseClone();
-    public void Serialize(System.IO.Stream stream, ValveKeyValue.KVFile data, ValveKeyValue.KVSerializerOptions options);
+    public void Serialize(System.IO.Stream stream, ValveKeyValue.KVDocument data, ValveKeyValue.KVSerializerOptions options);
     public void Serialize(System.IO.Stream stream, ValveKeyValue.KVObject data, ValveKeyValue.KVSerializerOptions options);
     public void Serialize<ValveKeyValue.TData>(System.IO.Stream stream, ValveKeyValue.TData data, string name, ValveKeyValue.KVSerializerOptions options);
     public string ToString();

diff --git a/ValveKeyValue/ValveKeyValue/KVFile.cs → ValveKeyValue/ValveKeyValue/KVDocument.cs b/ValveKeyValue/ValveKeyValue/KVFile.cs → ValveKeyValue/ValveKeyValue/KVDocument.cs
@@ -1,8 +1,8 @@
 namespace ValveKeyValue
 {
-    public class KVFile : KVObject
+    public class KVDocument : KVObject
     {
-        public KVFile(string name, KVValue value) : base(name, value)
+        public KVDocument(string name, KVValue value) : base(name, value)
         {
             // KV3 will require a header field that contains format/encoding here.
         }

diff --git a/ValveKeyValue/ValveKeyValue/KVSerializer.cs b/ValveKeyValue/ValveKeyValue/KVSerializer.cs
@@ -30,8 +30,8 @@ public static KVSerializer Create(KVSerializationFormat format)
         /// </summary>
         /// <param name="stream">The stream to deserialize from.</param>
         /// <param name="options">Options to use that can influence the deserialization process.</param>
-        /// <returns>A <see cref="KVFile"/> representing the KeyValues structure encoded in the stream.</returns>
-        public KVFile Deserialize(Stream stream, KVSerializerOptions options = null)
+        /// <returns>A <see cref="KVDocument"/> representing the KeyValues structure encoded in the stream.</returns>
+        public KVDocument Deserialize(Stream stream, KVSerializerOptions options = null)
         {
             Require.NotNull(stream, nameof(stream));
             var builder = new KVObjectBuilder();
@@ -42,7 +42,7 @@ public KVFile Deserialize(Stream stream, KVSerializerOptions options = null)
             }
 
             var root = builder.GetObject();
-            return new KVFile(root.Name, root.Value);
+            return new KVDocument(root.Name, root.Value);
         }
 
         /// <summary>
@@ -80,7 +80,7 @@ public void Serialize(Stream stream, KVObject data, KVSerializerOptions options
         /// <param name="stream">The stream to serialize into.</param>
         /// <param name="data">The data to serialize.</param>
         /// <param name="options">Options to use that can influence the serialization process.</param>
-        public void Serialize(Stream stream, KVFile data, KVSerializerOptions options = null) =>
+        public void Serialize(Stream stream, KVDocument data, KVSerializerOptions options = null) =>
             Serialize(stream, data, options);
 
         /// <summary>