SpecialPath Enum

Summary

Represents a special path.
Namespace
Cake.Core.IO
Interfaces
  • IComparable
  • ISpanFormattable
  • IFormattable
  • IConvertible
Base Types
  • object
  • ValueType
  • Enum
graph BT Type-->Base0["Enum"] Base0-->Base1["ValueType"] Base1-->Base2["object"] Type-.->Interface0["IComparable"] Type-.->Interface1["ISpanFormattable"] Type-.->Interface2["IFormattable"] Type-.->Interface3["IConvertible"] Type["SpecialPath"] class Type type-node

Syntax

public enum SpecialPath

Fields

Name Constant Value Summary
ApplicationData 0
The directory that serves as a common repository for application-specific data for the current roaming user.
static
CommonApplicationData 1
The directory that serves as a common repository for application-specific data that is used by all users.
static
LocalApplicationData 2
The directory that serves as a common repository for application-specific data that is used by the current, non-roaming user.
static
LocalTemp 6
The current user's temporary folder.
static
ProgramFiles 3
The Program Files folder.
static
ProgramFilesX86 4
The Program Files (X86) folder.
static
UserProfile 7
The user's profile folder.
static
Windows 5
The Windows folder.
static

Extension Methods

Name Value Summary
Dump<SpecialPath>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SpecialPath>(SpecialPath[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
ThrowIfNull<SpecialPath>(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<SpecialPath>(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