-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from Atypical-Consulting/9-create-documentatio…
…n-on-github-page Create api documentation
- Loading branch information
Showing
135 changed files
with
2,771 additions
and
3 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.CreationTime.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode.CreationTime Property | ||
|
||
Gets the creation time of the node. | ||
|
||
```csharp | ||
public System.DateTimeOffset CreationTime { get; } | ||
``` | ||
|
||
Implements [CreationTime](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.CreationTime.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.CreationTime') | ||
|
||
#### Property Value | ||
[System.DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/System.DateTimeOffset 'System.DateTimeOffset') |
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsDirectory.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode.IsDirectory Property | ||
|
||
Indicates whether the node is a directory. | ||
|
||
```csharp | ||
public abstract bool IsDirectory { get; } | ||
``` | ||
|
||
Implements [IsDirectory](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsDirectory.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsDirectory') | ||
|
||
#### Property Value | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsFile.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode.IsFile Property | ||
|
||
Indicates whether the node is a file. | ||
|
||
```csharp | ||
public abstract bool IsFile { get; } | ||
``` | ||
|
||
Implements [IsFile](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsFile.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsFile') | ||
|
||
#### Property Value | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastAccessTime.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode.LastAccessTime Property | ||
|
||
Gets the last access time of the node. | ||
|
||
```csharp | ||
public System.DateTimeOffset LastAccessTime { get; } | ||
``` | ||
|
||
Implements [LastAccessTime](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastAccessTime.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastAccessTime') | ||
|
||
#### Property Value | ||
[System.DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/System.DateTimeOffset 'System.DateTimeOffset') |
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastWriteTime.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode.LastWriteTime Property | ||
|
||
Gets the last write time of the node. | ||
|
||
```csharp | ||
public System.DateTimeOffset LastWriteTime { get; } | ||
``` | ||
|
||
Implements [LastWriteTime](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastWriteTime.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastWriteTime') | ||
|
||
#### Property Value | ||
[System.DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/System.DateTimeOffset 'System.DateTimeOffset') |
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.Path.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode.Path Property | ||
|
||
Gets the creation time of the node. | ||
|
||
```csharp | ||
public abstract Atypical.VirtualFileSystem.Core.Abstractions.VFSPath Path { get; } | ||
``` | ||
|
||
Implements [Path](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.Path.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.Path') | ||
|
||
#### Property Value | ||
[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') |
18 changes: 18 additions & 0 deletions
18
...ctions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') | ||
|
||
## VFSNode(VFSPath) Constructor | ||
|
||
Initializes a new instance of the [VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') class. | ||
This constructor is used by derived classes. | ||
|
||
```csharp | ||
protected VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath path); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).path'></a> | ||
|
||
`path` [VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
The path of the node. |
34 changes: 34 additions & 0 deletions
34
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions') | ||
|
||
## VFSNode Class | ||
|
||
Represents a node in a virtual file system. | ||
A node can be a file or a directory. | ||
|
||
```csharp | ||
public abstract class VFSNode : | ||
Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode, | ||
System.IEquatable<Atypical.VirtualFileSystem.Core.Abstractions.VFSNode> | ||
``` | ||
|
||
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 VFSNode | ||
|
||
Derived | ||
↳ [DirectoryNode](Atypical.VirtualFileSystem.Core.Models.DirectoryNode.md 'Atypical.VirtualFileSystem.Core.Models.DirectoryNode') | ||
↳ [FileNode](Atypical.VirtualFileSystem.Core.Models.FileNode.md 'Atypical.VirtualFileSystem.Core.Models.FileNode') | ||
|
||
Implements [IVirtualFileSystemNode](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode'), [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') | ||
| Constructors | | | ||
| :--- | :--- | | ||
| [VFSNode(VFSPath)](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath)') | Initializes a new instance of the [VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') class.<br/>This constructor is used by derived classes. | | ||
|
||
| Properties | | | ||
| :--- | :--- | | ||
| [CreationTime](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.CreationTime.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.CreationTime') | Gets the creation time of the node. | | ||
| [IsDirectory](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsDirectory.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsDirectory') | Indicates whether the node is a directory. | | ||
| [IsFile](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsFile.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsFile') | Indicates whether the node is a file. | | ||
| [LastAccessTime](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastAccessTime.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastAccessTime') | Gets the last access time of the node. | | ||
| [LastWriteTime](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastWriteTime.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastWriteTime') | Gets the last write time of the node. | | ||
| [Path](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.Path.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.Path') | Gets the creation time of the node. | |
21 changes: 21 additions & 0 deletions
21
...ypical.VirtualFileSystem.Core.Abstractions.VFSPath.CleanVFSPathInput(string).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.CleanVFSPathInput(string) Method | ||
|
||
Cleans the input path. | ||
|
||
```csharp | ||
private string CleanVFSPathInput(string path); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.CleanVFSPathInput(string).path'></a> | ||
|
||
`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
||
The path to clean. | ||
|
||
#### Returns | ||
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
The cleaned path. |
16 changes: 16 additions & 0 deletions
16
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Depth.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.Depth Property | ||
|
||
Gets the depth of the file system entry. | ||
The root directory has a depth of 0. | ||
The depth of a file is the depth of its parent directory plus one. | ||
The depth of a directory is the depth of its parent directory plus one. | ||
|
||
```csharp | ||
public int Depth { get; } | ||
``` | ||
|
||
#### Property Value | ||
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') |
21 changes: 21 additions & 0 deletions
21
...actions.VFSPath.Equals(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.Equals(VFSPath) Method | ||
|
||
Indicates whether the current object is equal to another object of the same type. | ||
|
||
```csharp | ||
public virtual bool Equals(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath? other); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Equals(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).other'></a> | ||
|
||
`other` [VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
An object to compare with this object. | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') | ||
A value that indicates whether the current object is equal to the [other](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Equals(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).md#Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Equals(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).other 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Equals(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).other') parameter. |
29 changes: 29 additions & 0 deletions
29
...pical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.GetAbsoluteParentPath(int) Method | ||
|
||
Gets the absolute path of the parent directory with depth [depthFromRoot](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).md#Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).depthFromRoot 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).depthFromRoot'). | ||
The root directory has a depth of 0. | ||
The depth of a file is the depth of its parent directory plus one. | ||
The depth of a directory is the depth of its parent directory plus one. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Abstractions.VFSPath GetAbsoluteParentPath(int depthFromRoot); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).depthFromRoot'></a> | ||
|
||
`depthFromRoot` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') | ||
|
||
The depth of the parent directory from the root directory. | ||
|
||
#### Returns | ||
[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
The absolute path of the parent directory with depth [depthFromRoot](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).md#Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).depthFromRoot 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetAbsoluteParentPath(int).depthFromRoot'). | ||
|
||
#### Exceptions | ||
|
||
[System.ArgumentOutOfRangeException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentOutOfRangeException 'System.ArgumentOutOfRangeException') | ||
Thrown when the depth is negative. |
14 changes: 14 additions & 0 deletions
14
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.GetHashCode().md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.GetHashCode() Method | ||
|
||
Serves as the default hash function. | ||
|
||
```csharp | ||
public override int GetHashCode(); | ||
``` | ||
|
||
#### Returns | ||
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') | ||
A hash code for the current object. |
13 changes: 13 additions & 0 deletions
13
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.HasParent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.HasParent Property | ||
|
||
Indicates whether the path has a parent directory. | ||
|
||
```csharp | ||
public bool HasParent { get; } | ||
``` | ||
|
||
#### Property Value | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
13 changes: 13 additions & 0 deletions
13
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.IsRoot.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.IsRoot Property | ||
|
||
Gets a value indicating whether the directory is the root directory. | ||
|
||
```csharp | ||
public bool IsRoot { get; } | ||
``` | ||
|
||
#### Property Value | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
15 changes: 15 additions & 0 deletions
15
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Name.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.Name Property | ||
|
||
Gets the name of the file system entry. | ||
The name of the root directory is [ROOT_PATH](Atypical.VirtualFileSystem.Core.VFSConstants.ROOT_PATH.md 'Atypical.VirtualFileSystem.Core.VFSConstants.ROOT_PATH'). | ||
The name of a file is the name of the file with its extension. | ||
|
||
```csharp | ||
public string Name { get; } | ||
``` | ||
|
||
#### Property Value | ||
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') |
13 changes: 13 additions & 0 deletions
13
doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.Parent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core') | ||
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath') | ||
|
||
## VFSPath.Parent Property | ||
|
||
Gets the path of the parent directory. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.ValueObjects.VFSDirectoryPath? Parent { get; } | ||
``` | ||
|
||
#### Property Value | ||
[VFSDirectoryPath](Atypical.VirtualFileSystem.Core.ValueObjects.VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.ValueObjects.VFSDirectoryPath') |
Oops, something went wrong.