McroBuild.PathUtils Class Reference

Support utilities for AbsolutePath. More...

Static Public Member Functions
static AbsolutePath	AsPath (this string input)
	Convert a left-side string to an AbsolutePath. In fact this is the recommended way to create an instance of AbsolutePath (as its constructor is private)
static AbsolutePath	AsPath (this FileReference input)
	Convert a left-side FileReference to an AbsolutePath. In fact this is the recommended way to create an instance of AbsolutePath (as its constructor is private)
static AbsolutePath	AsPath (this DirectoryReference input)
	Convert a left-side DirectoryReference to an AbsolutePath. In fact this is the recommended way to create an instance of AbsolutePath (as its constructor is private)
static string	WithUnixSeparator (this string input)
static string	GetPathRoot (string path)
static bool	HasPathRoot (string path)
static string	Combine (string left, string right, char? separator=null)
static string	NormalizePath (string path, char? separator=null)

Static Package Functions
static bool	IsWinRoot (string root)
static bool	IsUnixRoot (string root)
static bool	IsUncRoot (string root)
static bool	HasUnixRoot (string path)
static bool	HasUncRoot (string path)
static bool	HasWinRoot (string path)

Static Package Attributes
const char	WinSeparator = '\\'
const char	UncSeparator = '\\'
const char	UnixSeparator = '/'
static readonly char[]	AllSeparators = new [] { WinSeparator, UncSeparator, UnixSeparator }

Detailed Description

Support utilities for AbsolutePath.

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

Member Function Documentation

AsPath() [1/3]

static AbsolutePath McroBuild.PathUtils.AsPath ( this DirectoryReference input )

static

Convert a left-side DirectoryReference to an AbsolutePath. In fact this is the recommended way to create an instance of AbsolutePath (as its constructor is private)

Parameters

input

Input must be rooted

AsPath() [2/3]

static AbsolutePath McroBuild.PathUtils.AsPath ( this FileReference input )

static

Convert a left-side FileReference to an AbsolutePath. In fact this is the recommended way to create an instance of AbsolutePath (as its constructor is private)

Parameters

input

Input must be rooted

AsPath() [3/3]

static AbsolutePath McroBuild.PathUtils.AsPath ( this string input )

static

Convert a left-side string to an AbsolutePath. In fact this is the recommended way to create an instance of AbsolutePath (as its constructor is private)

Parameters

input

Input must be rooted

Combine()

static string McroBuild.PathUtils.Combine ( string left, string right, char? separator = null )

inlinestatic

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

GetPathRoot()

static string McroBuild.PathUtils.GetPathRoot ( string path )

inlinestatic

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

HasPathRoot()

static bool McroBuild.PathUtils.HasPathRoot ( string path )

static

HasUncRoot()

static bool McroBuild.PathUtils.HasUncRoot ( string path )

staticpackage

HasUnixRoot()

static bool McroBuild.PathUtils.HasUnixRoot ( string path )

staticpackage

HasWinRoot()

static bool McroBuild.PathUtils.HasWinRoot ( string path )

staticpackage

IsUncRoot()

static bool McroBuild.PathUtils.IsUncRoot ( string root )

staticpackage

IsUnixRoot()

static bool McroBuild.PathUtils.IsUnixRoot ( string root )

staticpackage

IsWinRoot()

static bool McroBuild.PathUtils.IsWinRoot ( string root )

staticpackage

NormalizePath()

static string McroBuild.PathUtils.NormalizePath ( string path, char? separator = null )

inlinestatic

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

WithUnixSeparator()

static string McroBuild.PathUtils.WithUnixSeparator ( this string input )

static

Field Documentation

AllSeparators

readonly char [] McroBuild.PathUtils.AllSeparators = new [] { WinSeparator, UncSeparator, UnixSeparator }

staticpackage

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

UncSeparator

const char McroBuild.PathUtils.UncSeparator = '\\'

staticpackage

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

UnixSeparator

const char McroBuild.PathUtils.UnixSeparator = '/'

staticpackage

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

WinSeparator

const char McroBuild.PathUtils.WinSeparator = '\\'

staticpackage

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

---

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

• McroBuild/AbsolutePath.Build.cs