linksplatform / io

LinksPlatform's Platform.IO Class Library

IO

LinksPlatform's Platform.IO Class Library.

Namespace: Platform.IO

Forked from: Konard/LinksPlatform/Platform/Platform.Helpers/IO

NuGet package: Platform.IO

Documentation

PDF file with code for e-readers.

Depend on

• Platform.Threading
• Platform.Unsafe

Dependent libraries

• Platform.Memory

io's Issues

Check what will happen if "\"" contains more quotes inside

IO/ConsoleHelpers.cs

Line 22 in d8a34a0

result = (result ?? "").Trim().Trim('"').Trim();

Use TryGetElement method from Platform.Collections here

IO/csharp/Platform.IO/ConsoleHelpers.cs

Lines 26 to 29 in f3b9c68

	if (args != null && args.Length > index)
	{
	result = args[index];
	}

Add comments on public classes and methods

Platform.IO

• ConsoleCancellation
• ConsoleHelpers
• FileHelpers
• StreamExtensions

Translate the code from C# to C++

500 RUB reward can be claimed by anyone who completes this task.

Rename to UsedFilesListLockObject

IO/csharp/Platform.IO/TemporaryFiles.cs

Line 14 in 2f45255

private static readonly object UsedFilesListLock = new();

This method should be called in the static constructor of TemporaryFiles class

IO/csharp/Platform.IO/TemporaryFiles.cs

Line 46 in 2f45255

public static void DeleteAllPreviouslyUsed()

Rename directory argument

IO/csharp/Platform.IO/FileHelpers.cs

Line 288 in 164fc97

public static void DeleteAll(string directory, string searchPattern, SearchOption searchOption)

We should use path instead of old name.

See Directory.EnumerateFiles method in the .NET documentation.

After this change comments to these methods can be simplified.

This method does not corresponds to OrDefault methods convention

IO/csharp/Platform.IO/FileHelpers.cs

Line 44 in 00ac8c5

throw new InvalidOperationException($"File is not aligned to elements with size {elementSize}.");

By the convention all methods ended with OrDefault are expected to return default value in any unexpected case. Such methods are not expected to throw exceptions.

Add `Platform.IO.h` and include there all libraries that are used

Example: https://github.com/linksplatform/Interfaces/blob/master/cpp/Platform.Interfaces/Platform.Interfaces.h

Use PackageLicenseExpression

IO/Platform.IO.csproj

Line 15 in af42b04

<PackageLicenseUrl>https://github.com/linksplatform/IO/blob/master/LICENSE</PackageLicenseUrl>

Cover the code with tests

Internationalization of messages

IO/ConsoleHelpers.cs

Line 10 in e4f8867

// TODO: Internationalization

Add an ability to specify default value

IO/csharp/Platform.IO/ConsoleHelpers.cs

Line 66 in e708c30

public static string GetOrReadArgument(int index, string readMessage, params string[] args)

Logic does not support drag & drop of the filename from Windows Explorer

IO/ConsoleHelpers.cs

Line 30 in 9cc94ac

result = (result ?? "").Trim();

Should be the same as:

IO/ConsoleHelpers.cs

Line 24 in 9cc94ac

result = (result ?? "").Trim().Trim('"').Trim();

Because it is possible to get a string from a drag & drop of the filename from Windows Explorer.

The unused parameter

The manual parameter is unused

IO/csharp/Platform.IO/ConsoleCancellation.cs

Line 58 in 5180cd5

protected override void Dispose(bool manual, bool wasDisposed)

Use updated PNG logo icon

IO/Platform.IO.csproj

Line 12 in af42b04

<PackageTags>LinksPlatform;IO;FileHelpers;StreamExtensions;ConsoleHelpers;ConsoleCancellationHandler</PackageTags>

New logo icon:
https://raw.githubusercontent.com/linksplatform/Documentation/18469f4d033ee9a5b7b84caab9c585acab2ac519/doc/Avatar-rainbow-icon-64x64.png

Rename DeleteAll method

IO/csharp/Platform.IO/FileHelpers.cs

Line 288 in 164fc97

public static void DeleteAll(string directory, string searchPattern, SearchOption searchOption)

This method should be called DeleteFiles or DeleteMany.

Check that argument is not trimmed already

IO/ConsoleHelpers.cs

Line 22 in d8a34a0

result = (result ?? "").Trim().Trim('"').Trim();

Related to #10.

Make sure `TemproryFile` is as good as `tmpfile` from C/C++ or better.

IO/csharp/Platform.IO/TemporaryFile.cs

Lines 8 to 61 in 92be3b1

	/// <summary>
	/// <para>Represents a self-deleting temporary file.</para>
	/// <para>Представляет самоудаляющийся временный файл.</para>
	/// </summary>
	public class TemporaryFile : DisposableBase
	{
	/// <summary>
	/// <para>Gets a temporary file path.</para>
	/// <para>Возвращает путь к временному файлу.</para>
	/// </summary>
	public readonly string Filename;
	/// <summary>
	/// <para>Converts the <see cref="TemporaryFile"/> instance to <see cref="string"/> using the <see cref="Filename"/> field value.</para>
	/// <para>Преобразует экземпляр <see cref="TemporaryFile"/> в <see cref="string"/> используя поле <see cref="Filename"/>.</para>
	/// </summary>
	/// <param name="file">
	/// <para>A <see cref="TemporaryFile"/> instance.</para>
	/// <para>Экземпляр <see cref="TemporaryFile"/>.</para>
	/// </param>
	/// <returns>
	/// <para>Path to the temporary file.</para>
	/// <para>Путь к временному файлу.</para>
	/// </returns>
	public static implicit operator string(TemporaryFile file) => file.Filename;
	/// <summary>
	/// <para>Initializes a <see cref="TemporaryFile"/> instance.</para>
	/// <para>Инициализирует экземпляр класса <see cref="TemporaryFile"/>.</para>
	/// </summary>
	[MethodImpl(MethodImplOptions.AggressiveInlining)]
	public TemporaryFile() => Filename = TemporaryFiles.UseNew();
	/// <summary>
	/// <para>Deletes the temporary file.</para>
	/// <para>Удаляет временный файл.</para>
	/// </summary>
	/// <param name="manual">
	/// <para>A <see cref="Boolean"/> value that determines whether the disposal was triggered manually (by the developer's code) or was executed automatically without an explicit indication from a developer.</para>
	/// <para>Значение типа <see cref="Boolean"/>, определяющие было ли высвобождение вызвано вручную (кодом разработчика) или же выполнилось автоматически без явного указания со стороны разработчика.</para>
	/// </param>
	/// <param name="wasDisposed">
	/// <para>A <see cref="Boolean"/> value that determines whether the <see cref="TemporaryFile"/> was released before a call to this method.</para>
	/// <para>Значение типа <see cref="Boolean"/>, определяющие были ли освобождены ресурсы, используемые <see cref="TemporaryFile"/> до вызова данного метода.</para>
	/// </param>
	[MethodImpl(MethodImplOptions.AggressiveInlining)]
	protected override void Dispose(bool manual, bool wasDisposed)
	{
	if (!wasDisposed)
	{
	File.Delete(Filename);
	}
	}
	}

Make all these members public

IO/csharp/Platform.IO/TemporaryFiles.cs

Lines 13 to 17 in 2f45255

	private const string UserFilesListFileNamePrefix = ".used-temporary-files.txt";
	private static readonly object UsedFilesListLock = new();
	private static readonly string UsedFilesListFilename = Assembly.GetExecutingAssembly().Location + UserFilesListFileNamePrefix;
	[MethodImpl(MethodImplOptions.AggressiveInlining)]
	private static void AddToUsedFilesList(string filename)