MCRO
C++23 utilities for Unreal Engine.
Loading...
Searching...
No Matches
McroBuild.AbsolutePath Class Reference

A simplified copy of NUKE's own AbsolutePath class https://github.com/nuke-build/nuke/blob/develop/source/Nuke.Utilities/IO/AbsolutePath.cs. More...

Inheritance diagram for McroBuild.AbsolutePath:

Public Member Functions

override bool Equals (object obj)
 
override int GetHashCode ()
 
override string ToString ()
 

Static Public Member Functions

static AbsolutePath Create (string path)
 Create an AbsolutePath from a string.
 
static implicit operator AbsolutePath (string path)
 Convert a string to an AbsolutePath.
 
static implicit operator string (AbsolutePath path)
 Use AbsolutePath where an API expects a string representing a path.
 
static AbsolutePath operator/ (AbsolutePath left, Range range)
 Use completely valid C# syntax MyPath/ .. to access ancestor.
 
static AbsolutePath operator/ (AbsolutePath left, string right)
 Append a path segment to this AbsolutePath.
 
static AbsolutePath operator+ (AbsolutePath left, string right)
 Append a piece of string to this AbsolutePath without any intersperse.
 
static bool operator== (AbsolutePath a, AbsolutePath b)
 
static bool operator!= (AbsolutePath a, AbsolutePath b)
 

Static Public Attributes

const string DoubleQuote = "dq"
 
const string SingleQuote = "sq"
 
const string NoQuotes = "nq"
 

Protected Member Functions

bool Equals (AbsolutePath other)
 

Properties

string Name [get]
 Get the filename (with extension) or the directory name.
 
string NameWithoutExtension [get]
 Get the filename (without extension)
 
string Extension [get]
 Get the extension of the filename.
 
AbsolutePath Parent [get]
 The ancestor of this path (..)
 

Detailed Description

Member Function Documentation

◆ Create()

static AbsolutePath McroBuild.AbsolutePath.Create ( string path)
inlinestatic

Create an AbsolutePath from a string.

Parameters
pathInput path must be rooted.

Definition at line 42 of file AbsolutePath.Build.cs.

◆ Equals() [1/2]

bool McroBuild.AbsolutePath.Equals ( AbsolutePath other)
inlineprotected

Definition at line 114 of file AbsolutePath.Build.cs.

◆ Equals() [2/2]

override bool McroBuild.AbsolutePath.Equals ( object obj)
inline

Definition at line 130 of file AbsolutePath.Build.cs.

◆ GetHashCode()

override int McroBuild.AbsolutePath.GetHashCode ( )
inline

Definition at line 141 of file AbsolutePath.Build.cs.

◆ operator AbsolutePath()

static implicit McroBuild.AbsolutePath.operator AbsolutePath ( string path)
inlinestatic

Convert a string to an AbsolutePath.

Parameters
pathInput path must be rooted.

Definition at line 51 of file AbsolutePath.Build.cs.

◆ operator string()

static implicit McroBuild.AbsolutePath.operator string ( AbsolutePath path)
inlinestatic

Use AbsolutePath where an API expects a string representing a path.

Definition at line 62 of file AbsolutePath.Build.cs.

◆ operator!=()

static bool McroBuild.AbsolutePath.operator!= ( AbsolutePath a,
AbsolutePath b )
inlinestatic

Definition at line 125 of file AbsolutePath.Build.cs.

◆ operator+()

static AbsolutePath McroBuild.AbsolutePath.operator+ ( AbsolutePath left,
string right )
inlinestatic

Append a piece of string to this AbsolutePath without any intersperse.

Definition at line 109 of file AbsolutePath.Build.cs.

◆ operator/() [1/2]

static AbsolutePath McroBuild.AbsolutePath.operator/ ( AbsolutePath left,
Range range )
inlinestatic

Use completely valid C# syntax MyPath/ .. to access ancestor.

Definition at line 93 of file AbsolutePath.Build.cs.

◆ operator/() [2/2]

static AbsolutePath McroBuild.AbsolutePath.operator/ ( AbsolutePath left,
string right )
inlinestatic

Append a path segment to this AbsolutePath.

Definition at line 101 of file AbsolutePath.Build.cs.

◆ operator==()

static bool McroBuild.AbsolutePath.operator== ( AbsolutePath a,
AbsolutePath b )
inlinestatic

Definition at line 120 of file AbsolutePath.Build.cs.

◆ ToString()

override string McroBuild.AbsolutePath.ToString ( )
inline

Definition at line 146 of file AbsolutePath.Build.cs.

Field Documentation

◆ DoubleQuote

const string McroBuild.AbsolutePath.DoubleQuote = "dq"
static

Definition at line 151 of file AbsolutePath.Build.cs.

◆ NoQuotes

const string McroBuild.AbsolutePath.NoQuotes = "nq"
static

Definition at line 153 of file AbsolutePath.Build.cs.

◆ SingleQuote

const string McroBuild.AbsolutePath.SingleQuote = "sq"
static

Definition at line 152 of file AbsolutePath.Build.cs.

Property Documentation

◆ Extension

string McroBuild.AbsolutePath.Extension
get

Get the extension of the filename.

Definition at line 80 of file AbsolutePath.Build.cs.

◆ Name

string McroBuild.AbsolutePath.Name
get

Get the filename (with extension) or the directory name.

Definition at line 70 of file AbsolutePath.Build.cs.

◆ NameWithoutExtension

string McroBuild.AbsolutePath.NameWithoutExtension
get

Get the filename (without extension)

Definition at line 75 of file AbsolutePath.Build.cs.

◆ Parent

AbsolutePath McroBuild.AbsolutePath.Parent
get

The ancestor of this path (..)

Definition at line 85 of file AbsolutePath.Build.cs.


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