FileSurfer.Core.Models.Location Class Reference

Represents a directory location path bound to a specific file system. More...

Public Member Functions
	Location (IFileSystem fileSystem, string dirPath)
	Initializes a new instance of the Location class.
bool	Exists ()
	Determines whether this directory exists.
async Task< bool >	ExistsAsync ()
	Determines asynchronously whether this directory exists.
bool	IsSame (Location? other)
	Determines whether this location points to the same directory as another location.
override string	ToString ()

Properties
string	Path [get]
	Gets the full path to the location.
IFileSystem	FileSystem [get]
	Gets the file system that owns this location.

Detailed Description

Represents a directory location path bound to a specific file system.

Constructor & Destructor Documentation

Location()

FileSurfer.Core.Models.Location.Location ( IFileSystem fileSystem, string dirPath )

inline

Initializes a new instance of the Location class.

Parameters

fileSystem	File system that owns the provided path.
dirPath	Directory path represented by this location.

Here is the caller graph for this function:

Member Function Documentation

Exists()

bool FileSurfer.Core.Models.Location.Exists ( )

inline

Determines whether this directory exists.

Returns

true when the file system is ready and the directory exists; otherwise false.

ExistsAsync()

async Task< bool > FileSurfer.Core.Models.Location.ExistsAsync ( )

inline

Determines asynchronously whether this directory exists.

Returns

A task that returns true when the file system is ready and the directory exists; otherwise false.

Here is the caller graph for this function:

IsSame()

bool FileSurfer.Core.Models.Location.IsSame ( Location? other )

inline

Determines whether this location points to the same directory as another location.

Parameters

other

Location to compare with.

Returns

true when both locations represent the same directory in the same file-system context; otherwise false.

Here is the call graph for this function:

ToString()

override string FileSurfer.Core.Models.Location.ToString ( )

inline

Property Documentation

FileSystem

IFileSystem FileSurfer.Core.Models.Location.FileSystem

get

Gets the file system that owns this location.

Path

string FileSurfer.Core.Models.Location.Path

get

Gets the full path to the location.

---

The documentation for this class was generated from the following file:

• /home/janecea/Documents/CODE/PROJECTS/FileSurfer/src/FileSurfer.Core/Models/Location.cs