Represents a directory. Not all implementations will support all available methods and may throw System.NotSupportedException.

Namespace

Interfaces

Implementing Types

TestDirectory

graph BT Type-.->Interface0["IFileSystemEntry"] click Interface0 "/api/Statiq.Common/IFileSystemEntry" Type-.->Interface1["IDisplayable"] click Interface1 "/api/Statiq.Common/IDisplayable" Type["IDirectory"] class Type type-node Implementing0["TestDirectory"]-.->Type click Implementing0 "/api/Statiq.Testing/TestDirectory"

Syntax

public interface IDirectory : IFileSystemEntry, IDisplayable

Properties

Name	Property Type	Summary
Parent	IDirectory	Gets the parent directory.
Path	NormalizedPath	Gets the path to the directory.

Methods

Name	Return Value	Summary
Create()	void	Creates the directory, including any necessary parent directories.
Delete(bool)	void	Deletes the directory.
GetDirectories(SearchOption)	IEnumerable<IDirectory>	Gets directories matching the specified filter and scope.
GetDirectory(NormalizedPath)	IDirectory	Gets a directory by combining it's path with the current directory's path. The specified directory path must be relative.
GetFile(NormalizedPath)	IFile	Gets a file by combining it's path with the current directory's path. The specified file path must be relative.
GetFiles(SearchOption)	IEnumerable<IFile>	Gets files matching the specified filter and scope.
MoveTo(IDirectory)	void	Moves the directory and it's contents to a new parent directory.
MoveTo(NormalizedPath)	void	Moves the directory and it's contents to a new parent path.

Extension Methods

Name	Value	Summary
ThrowIfNull<IDirectory>(string)	T	From GuardExtensions
ToDocument<IDirectory>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IDirectory>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IDirectory>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IDirectory>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IDirectory>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IDirectory>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToSafeDisplayString()	string	A safe display string that can be used for logging and returns "null" when the underlying object is null. From IDisplayableExtensions