mirror of
https://github.com/danbulant/Cosmos
synced 2026-05-21 13:28:41 +00:00
Done DirectoryEntry api docs
This commit is contained in:
parent
8bac7ed946
commit
eb4b746414
1 changed files with 33 additions and 6 deletions
|
|
@ -29,11 +29,26 @@ namespace Cosmos.System.FileSystem.Listing
|
|||
/// </summary>
|
||||
public abstract class DirectoryEntry
|
||||
{
|
||||
/// <summary>
|
||||
/// Entry size.
|
||||
/// </summary>
|
||||
public long mSize;
|
||||
/// <summary>
|
||||
/// Entry full path.
|
||||
/// </summary>
|
||||
public string mFullPath;
|
||||
/// <summary>
|
||||
/// Entry name.
|
||||
/// </summary>
|
||||
public string mName;
|
||||
protected readonly FileSystem mFileSystem;
|
||||
/// <summary>
|
||||
/// Entry parent.
|
||||
/// </summary>
|
||||
public readonly DirectoryEntry mParent;
|
||||
/// <summary>
|
||||
/// Entry type.
|
||||
/// </summary>
|
||||
public readonly DirectoryEntryTypeEnum mEntryType;
|
||||
|
||||
/// <summary>
|
||||
|
|
@ -45,12 +60,8 @@ namespace Cosmos.System.FileSystem.Listing
|
|||
/// <param name="aName">The entry name.</param>
|
||||
/// <param name="aSize">The size of the entry.</param>
|
||||
/// <param name="aEntryType">The ype of the entry.</param>
|
||||
/// <exception cref="ArgumentNullException"></exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// Argument is null or empty
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentOutOfRangeException">
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentNullException">Thrown if aFileSystem is null.</exception>
|
||||
/// <exception cref="ArgumentException">Thrown if aFullPath / aName is null.</exception>
|
||||
protected DirectoryEntry(FileSystem aFileSystem, DirectoryEntry aParent, string aFullPath, string aName, long aSize, DirectoryEntryTypeEnum aEntryType)
|
||||
{
|
||||
if (aFileSystem == null)
|
||||
|
|
@ -74,12 +85,28 @@ namespace Cosmos.System.FileSystem.Listing
|
|||
mFullPath = aFullPath;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Set entry name.
|
||||
/// </summary>
|
||||
/// <param name="aName">A name to be set.</param>
|
||||
public abstract void SetName(string aName);
|
||||
|
||||
/// <summary>
|
||||
/// Set entry size.
|
||||
/// </summary>
|
||||
/// <param name="aSize">A size to be set.</param>
|
||||
public abstract void SetSize(long aSize);
|
||||
|
||||
/// <summary>
|
||||
/// Get file stream.
|
||||
/// </summary>
|
||||
/// <returns>Stream value.</returns>
|
||||
public abstract Stream GetFileStream();
|
||||
|
||||
/// <summary>
|
||||
/// Get used space.
|
||||
/// </summary>
|
||||
/// <returns>long value.</returns>
|
||||
public abstract long GetUsedSpace();
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue