ktsu.io.StrongPaths
1.1.1
Prefix Reserved
dotnet add package ktsu.io.StrongPaths --version 1.1.1
NuGet\Install-Package ktsu.io.StrongPaths -Version 1.1.1
<PackageReference Include="ktsu.io.StrongPaths" Version="1.1.1" />
paket add ktsu.io.StrongPaths --version 1.1.1
#r "nuget: ktsu.io.StrongPaths, 1.1.1"
// Install ktsu.io.StrongPaths as a Cake Addin #addin nuget:?package=ktsu.io.StrongPaths&version=1.1.1 // Install ktsu.io.StrongPaths as a Cake Tool #tool nuget:?package=ktsu.io.StrongPaths&version=1.1.1
StrongPaths
A library that provides strong typing for common filesystem paths providing compile time feedback and runtime validation.
StrongPaths is a collection of classes derived from ktsu.io.StrongStrings
with added functionality and helper methods for filesystem paths.
Get familiar with the StrongStrings library to get the most out of StrongPaths.
Usage
using ktsu.io.StrongPaths;
public class MyDemoClass
{
public AbsoluteDirectoryPath OutputDir { get; set; } = (AbsoluteDirectoryPath)@"c:\output";
public void SaveData(RelativeDirectoryPath subDir, FileName fileName)
{
// You can use the / operator to combine paths
AbsoluteFilePath filePath = OutputDir / subDir / fileName;
File.WriteAllText(filePath, "Hello, world!");
// An AbsoluteDirectoryPath combined with a RelativeDirectoryPath returns an AbsoluteDirectoryPath
AbsoluteDirectoryPath newOutputDir = OutputDir / subDir;
// An AbsoluteDirectoryPath combined with a FileName returns an AbsoluteFilePath
AbsoluteFilePath newFilePath = newOutputDir / fileName;
// You can get a relative path from Absolute/Relative Directory/File paths using the RelativeTo method
RelativeDirectoryPath relativePath = newOutputDir.RelativeTo(OutputDir);
RelativeFilePath relativeFilePath = newFilePath.RelativeTo(OutputDir);
RelativeDirectoryPath relativePath2 = newOutputDir.RelativeTo(filePath);
RelativeFilePath relativeFilePath2 = newFilePath.RelativeTo(filePath);
}
public void Demo()
{
string storeLocation = "melbourne";
RelativeDirectoryPath storeDir = (RelativeDirectoryPath)$"store_{storeLocation}";
FileName fileName = (FileName)$"{DateTime.UtcNow}.json";
SaveData(storeDir, fileName);
}
}
Concrete Types
AbsolutePath
RelativePath
DirectoryPath
FilePath
FileName
FileExtension
AbsoluteDirectoryPath
RelativeDirectoryPath
AbsoluteFilePath
RelativeFilePath
Abstract Base Classes
You can use these abstract base classes to accept a subset of path types in your method parameters:
AnyStrongPath
Accepts any of the concrete types and types derived from themAnyRelativePath
AcceptsRelativePath
,RelativeDirectroryPath
,RelativeFilePath
, and types derived from themAnyAbsolutePath
AcceptsAbsolutePath
,AbsoluteDirectroryPath
,AbsoluteFilePath
, and types derived from themAnyDirectoryPath
AcceptsDirectoryPath
,AbsoluteDirectroryPath
,RelativeDirectroryPath
, and types derived from themAnyFilePath
AcceptsFilePath
,AbsoluteFilePath
,RelativeFilePath
, and types derived from them
using ktsu.io.StrongPaths;
public static class MyDemoClass
{
public static void SaveData(AnyDirectoryPath outputDir, FileName fileName)
{
// You can't use the / operator with the abstract base classes because it has no way of knowing which type to return
// You have to use the Path.Combine method when using the abstract base classes
FilePath filePath = (FilePath)Path.Combine(outputDir, fileName);
File.WriteAllText(filePath, "Hello, World!");
}
public static void Demo()
{
string storeLocation = "melbourne";
RelativeDirectoryPath storeDir = (RelativeDirectoryPath)$"store_{storeLocation}";
FileName fileName = (FileName)$"{DateTime.UtcNow}.json";
SaveData(storeDir, fileName);
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net7.0
- ktsu.io.Extensions (>= 1.0.7)
- ktsu.io.StrongStrings (>= 1.1.0)
-
net8.0
- ktsu.io.Extensions (>= 1.0.7)
- ktsu.io.StrongStrings (>= 1.1.0)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on ktsu.io.StrongPaths:
Package | Downloads |
---|---|
ktsu.io.ImGuiApp
A bootstrap library to give you an environment to build an ImGUI.NET application with. |
|
ktsu.io.ImGuiWidgets
A library for custom widgets using ImGui.NET. |
|
ktsu.io.AppDataStorage
Application data management library using JSON serialization to save and load data in the user's app data folder. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.1.1 | 406 | 8/22/2024 |
1.1.0 | 97 | 8/21/2024 |
1.0.8 | 1,207 | 4/1/2024 |
1.0.7 | 131 | 3/27/2024 |
1.0.6 | 108 | 3/26/2024 |
1.0.5 | 94 | 3/26/2024 |
1.0.4 | 90 | 3/25/2024 |
1.0.3 | 79 | 3/25/2024 |
1.0.2 | 103 | 3/21/2024 |
1.0.1 | 84 | 3/21/2024 |
1.0.0 | 238 | 3/7/2024 |
1.0.0-alpha.6 | 71 | 2/29/2024 |
1.0.0-alpha.5 | 155 | 1/11/2024 |
1.0.0-alpha.4 | 69 | 1/11/2024 |
1.0.0-alpha.3 | 112 | 12/26/2023 |
1.0.0-alpha.2 | 81 | 12/19/2023 |
1.0.0-alpha.1 | 78 | 6/1/2023 |