Initial commit - WPinternals 2.6

DiscUtils/Vfs/IVfsFile.cs

@@ -0,0 +1,90 @@
+//
+// Copyright (c) 2008-2011, Kenneth Bell
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+
+namespace DiscUtils.Vfs
+{
+    using System;
+    using System.IO;
+
+    /// <summary>
+    /// Interface implemented by a class representing a file.
+    /// </summary>
+    /// <remarks>
+    /// File system implementations should have a class that implements this
+    /// interface.  If the file system implementation is read-only, it is
+    /// acceptable to throw <c>NotImplementedException</c> from setters.
+    /// </remarks>
+    public interface IVfsFile
+    {
+        /// <summary>
+        /// Gets or sets the last access time in UTC.
+        /// </summary>
+        DateTime LastAccessTimeUtc { get; set; }
+
+        /// <summary>
+        /// Gets or sets the last write time in UTC.
+        /// </summary>
+        DateTime LastWriteTimeUtc { get; set; }
+
+        /// <summary>
+        /// Gets or sets the last creation time in UTC.
+        /// </summary>
+        DateTime CreationTimeUtc { get; set; }
+
+        /// <summary>
+        /// Gets or sets the file's attributes.
+        /// </summary>
+        FileAttributes FileAttributes { get; set; }
+
+        /// <summary>
+        /// Gets the length of the file.
+        /// </summary>
+        long FileLength { get; }
+
+        /// <summary>
+        /// Gets a buffer to access the file's contents.
+        /// </summary>
+        IBuffer FileContent { get; }
+    }
+
+    /// <summary>
+    /// Interface implemented by classes representing files, in file systems that support multi-stream files.
+    /// </summary>
+    public interface IVfsFileWithStreams : IVfsFile
+    {
+        /// <summary>
+        /// Creates a new stream.
+        /// </summary>
+        /// <param name="name">The name of the stream.</param>
+        /// <returns>An object representing the stream.</returns>
+        SparseStream CreateStream(string name);
+
+        /// <summary>
+        /// Opens an existing stream.
+        /// </summary>
+        /// <param name="name">The name of the stream.</param>
+        /// <returns>An object representing the stream.</returns>
+        /// <remarks>The implementation must not implicitly create the stream if it doesn't already
+        /// exist.</remarks>
+        SparseStream OpenExistingStream(string name);
+    }
+}