IDirectory Interface

Summary

Represents a directory.
Namespace
Cake.Core.IO
Interfaces
Implementing Types
graph BT Type-.->Interface0["IFileSystemInfo"] click Interface0 "/api/Cake.Core.IO/IFileSystemInfo" Type["IDirectory"] class Type type-node Implementing0["FakeDirectory"]-.->Type click Implementing0 "/api/Cake.Testing/FakeDirectory"

Syntax

public interface IDirectory : IFileSystemInfo

Properties

Name Value Summary
Path DirectoryPath
Gets the path to the directory.

Methods

Name Value Summary
Create() void
Creates the directory.
Delete(bool) void
Deletes the directory.
GetDirectories(string, SearchScope) IEnumerable<IDirectory>
Gets directories matching the specified filter and scope.
GetFiles(string, SearchScope) IEnumerable<IFile>
Gets files matching the specified filter and scope.
Move(DirectoryPath) void
Moves the directory to the specified destination path.

Extension Methods

Name Value Summary
Dump<IDirectory>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
GetDirectories(string, SearchScope, Func<IFileSystemInfo, bool>, Action<IFileSystemInfo>) IEnumerable<IDirectory>
Gets directories matching the specified filter and scope, with option to exclude hidden directories.
GetDirectories(string, SearchScope, Func<IFileSystemInfo, bool>) IEnumerable<IDirectory>
Gets directories matching the specified filter and scope, with option to exclude hidden directories.
GetFiles(string, SearchScope, Func<IFileSystemInfo, bool>, Action<IFileSystemInfo>) IEnumerable<IFile>
Gets files matching the specified filter and scope.
GetFiles(string, SearchScope, Func<IFileSystemInfo, bool>) IEnumerable<IFile>
Gets files matching the specified filter and scope.
IsIn<IDirectory>(IDirectory[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IDirectory>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IDirectory>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<IDirectory>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<IDirectory>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin