From fec0caa448fbf180b6ed1577aaeb72b923207a02 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 6 Dec 2020 23:37:53 +0600 Subject: [PATCH 01/55] ReadAllChars method documentation --- csharp/Platform.IO/FileHelpers.cs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 82cfd59..e00c4e7 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -9,6 +9,18 @@ namespace Platform.IO { public static class FileHelpers { + /// + /// Reads all the text and return character array from the . + /// Читает весь текст и возвращает массив символов из . + /// + /// + /// The string passed to the application. + /// Строка переданная приложению. + /// + /// + /// A character array from the . + /// Массив символов из . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); From 8b744253c6a2116b5317c1efc70cf988340c64f1 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Feb 2021 17:47:24 +0600 Subject: [PATCH 02/55] Write method docs --- csharp/Platform.IO/StreamExtensions.cs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 235a6d7..9f144ac 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -8,6 +8,18 @@ namespace Platform.IO { public static class StreamExtensions { + /// + /// + /// + /// + /// Struct + /// Структура + /// + /// + /// An abstract class that provides an overview of a sequence of bytes + /// Абстрактный класс предоставляющий универсальное представление последовательности байтов + /// + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Write(this Stream stream, T value) where T : struct From 4ed6b1e79f6eefaf5c425d2fbe76fbf7db89d336 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Wed, 3 Mar 2021 16:09:12 +0600 Subject: [PATCH 03/55] StreamExtensions.Write Docs --- csharp/Platform.IO/StreamExtensions.cs | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 9f144ac..31e1c91 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -9,15 +9,16 @@ namespace Platform.IO public static class StreamExtensions { /// - /// + /// Writes a sequence of bytes derived from to the current stream and advances the current position within this stream by the number of bytes written. + /// Записывает последовательность байтов, полученных из в текущий поток и перемещает текущую позицию в нем вперед на число записанных байтов. /// /// - /// Struct - /// Структура + /// Struct. + /// Структура. /// /// - /// An abstract class that provides an overview of a sequence of bytes - /// Абстрактный класс предоставляющий универсальное представление последовательности байтов + /// An abstract class that provides an overview of a sequence of bytes. + /// Абстрактный класс предоставляющий универсальное представление последовательности байтов. /// /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -28,6 +29,19 @@ public static void Write(this Stream stream, T value) stream.Write(bytes, 0, bytes.Length); } + /// + /// Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. + /// + /// + /// + /// Struct. + /// Структура. + /// + /// + /// An abstract class that provides an overview of a sequence of bytes. + /// Абстрактный класс предоставляющий универсальное представление последовательности байтов. + /// + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) where T : struct From eccbe9fa0d6e7f7c0b725c021bde1b96b21ecf25 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 5 Mar 2021 16:41:34 +0600 Subject: [PATCH 04/55] Write method docs remarks. ReadOrDefault method docs. --- csharp/Platform.IO/StreamExtensions.cs | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 31e1c91..74662b5 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -9,8 +9,8 @@ namespace Platform.IO public static class StreamExtensions { /// - /// Writes a sequence of bytes derived from to the current stream and advances the current position within this stream by the number of bytes written. - /// Записывает последовательность байтов, полученных из в текущий поток и перемещает текущую позицию в нем вперед на число записанных байтов. + /// Writes a sequence of bytes representing to the stream . + /// Записывает последовательность байт представляющую в поток . /// /// /// Struct. @@ -20,7 +20,10 @@ public static class StreamExtensions /// An abstract class that provides an overview of a sequence of bytes. /// Абстрактный класс предоставляющий универсальное представление последовательности байтов. /// - /// + /// + /// Struct whose value pass to the stream . + /// Структура, значение которой записывается в поток . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Write(this Stream stream, T value) where T : struct @@ -30,7 +33,7 @@ public static void Write(this Stream stream, T value) } /// - /// Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. + /// Reads a sequence of bytes representing. /// /// /// From 5c493d0b1b99def2ae341cb0bc16aec84b35d011 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 5 Mar 2021 19:32:21 +0600 Subject: [PATCH 05/55] ReadAll method - docs --- csharp/Platform.IO/StreamExtensions.cs | 37 ++++++++++++++++---------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 74662b5..12d5e6f 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -9,19 +9,19 @@ namespace Platform.IO public static class StreamExtensions { /// - /// Writes a sequence of bytes representing to the stream . - /// Записывает последовательность байт представляющую в поток . + /// Writes a sequence of bytes representing to the stream and moves the current position within the by the number of written bytes. + /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в нем вперед на число записанных байт. /// /// - /// Struct. - /// Структура. + /// Type being structure. + /// Тип являющийся структурой. /// /// - /// An abstract class that provides an overview of a sequence of bytes. - /// Абстрактный класс предоставляющий универсальное представление последовательности байтов. + /// A stream to record. + /// Поток, в который осуществляется запись. /// /// - /// Struct whose value pass to the stream . + /// The struct value to be written to the .. /// Структура, значение которой записывается в поток . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -33,18 +33,21 @@ public static void Write(this Stream stream, T value) } /// - /// Reads a sequence of bytes representing. - /// + /// Reads a sequence of bytes representing the structure and moves the current position within the by the number of bytes read. + /// Прочитывает последовательность байт представляющих структуру и перемещает текущую позицию в вперед на число прочитанных байт.. /// /// - /// Struct. - /// Структура. + /// Type being structure. + /// Тип являющийся структурой. /// /// - /// An abstract class that provides an overview of a sequence of bytes. - /// Абстрактный класс предоставляющий универсальное представление последовательности байтов. + /// A stream containing the structure. + /// Поток, содержащий структуру. /// - /// + /// + /// The structure, if all bytes from stream have been read, otherwise the structure with default fields values. + /// Структура, если все байты из потока были прочитаны, иначе структура с значениями полей по умолчанию. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) where T : struct @@ -54,6 +57,12 @@ public static T ReadOrDefault(this Stream stream) return stream.Read(buffer, 0, size) == size ? buffer.ToStructure() : default; } + /// + /// + /// + /// + /// + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(this Stream stream) where T : struct From 2640f3fd2d8184bd79f052c2a26c86e7d91923d3 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 5 Mar 2021 21:07:33 +0600 Subject: [PATCH 06/55] ReadAll, Write methods - docs --- csharp/Platform.IO/StreamExtensions.cs | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 12d5e6f..afd3154 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -58,11 +58,21 @@ public static T ReadOrDefault(this Stream stream) } /// - /// + /// Reads and return array of structures from the strem . + /// Прочитывает и возвращает массив всех структур из потока . /// - /// - /// - /// + /// + /// Type being structure. + /// Тип являющийся структурой. + /// + /// + /// A stream containing the structure. + /// Поток, содержащий структуру. + /// + /// + /// The array with structures obtained from the stream . + /// Массив с структурами полученными из потока . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(this Stream stream) where T : struct From 1f7a1844bf0b00f12be542374ad3bc11d64eabc2 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 5 Mar 2021 22:41:25 +0600 Subject: [PATCH 07/55] Docs corrections --- csharp/Platform.IO/StreamExtensions.cs | 36 +++++++++++++------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index afd3154..8e27c64 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -13,16 +13,16 @@ public static class StreamExtensions /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в нем вперед на число записанных байт. /// /// - /// Type being structure. + /// The structure type. /// Тип являющийся структурой. /// /// - /// A stream to record. + /// A stream to write to. /// Поток, в который осуществляется запись. /// /// - /// The struct value to be written to the .. - /// Структура, значение которой записывается в поток . + /// The struct value to be written to the . + /// Значение структуры которое записывается в поток . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Write(this Stream stream, T value) @@ -33,20 +33,20 @@ public static void Write(this Stream stream, T value) } /// - /// Reads a sequence of bytes representing the structure and moves the current position within the by the number of bytes read. - /// Прочитывает последовательность байт представляющих структуру и перемещает текущую позицию в вперед на число прочитанных байт.. + /// Reads a sequence of bytes representing the structure and moves the current position within the by the number of read bytes. + /// Считывает последовательность байт представляющих структуру и перемещает текущую позицию в вперед на число прочитанных байт. /// /// - /// Type being structure. + /// The structure type. /// Тип являющийся структурой. /// /// - /// A stream containing the structure. - /// Поток, содержащий структуру. + /// A stream containing the structure. + /// Поток, содержащий структуру . /// /// - /// The structure, if all bytes from stream have been read, otherwise the structure with default fields values. - /// Структура, если все байты из потока были прочитаны, иначе структура с значениями полей по умолчанию. + /// The structure, if all bytes from stream have been read, otherwise the default value of structure. + /// Структура , если все байты из потока были прочитаны, иначе значение структуры по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) @@ -58,20 +58,20 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and return array of structures from the strem . - /// Прочитывает и возвращает массив всех структур из потока . + /// Reads and return array of structures from the strem . + /// Прочитывает и возвращает массив всех структур из потока . /// /// - /// Type being structure. + /// The structure type. /// Тип являющийся структурой. /// /// - /// A stream containing the structure. - /// Поток, содержащий структуру. + /// A stream containing the structure. + /// Поток, содержащий структуру . /// /// - /// The array with structures obtained from the stream . - /// Массив с структурами полученными из потока . + /// The array with structures obtained from the stream . + /// Массив с структурами полученными из потока . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(this Stream stream) From fa4c00ced6426b0518d1850467c41754b312bae5 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 16:35:44 +0600 Subject: [PATCH 08/55] ReadAllchars method - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index e00c4e7..37c86de 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -10,15 +10,15 @@ namespace Platform.IO public static class FileHelpers { /// - /// Reads all the text and return character array from the . + /// Reads all the text and returns character array from the . /// Читает весь текст и возвращает массив символов из . /// /// - /// The string passed to the application. - /// Строка переданная приложению. + /// The path to the file, from which to read the character array . + /// Путь к файлу, из которого нужно прочитать массив символов. /// /// - /// A character array from the . + /// The character array from the . /// Массив символов из . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From d2e9bedf1ecd98d6f16b5a894020b46ebd223f99 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 16:50:04 +0600 Subject: [PATCH 09/55] Methods - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 8e27c64..4578800 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -9,8 +9,8 @@ namespace Platform.IO public static class StreamExtensions { /// - /// Writes a sequence of bytes representing to the stream and moves the current position within the by the number of written bytes. - /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в нем вперед на число записанных байт. + /// Writes a sequence that represents the to the and moves the current position of the by the number of written bytes. + /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в нем вперед на число записанных байт. /// /// /// The structure type. @@ -22,7 +22,7 @@ public static class StreamExtensions /// /// /// The struct value to be written to the . - /// Значение структуры которое записывается в поток . + /// Значение структуры которое будет записано в поток . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Write(this Stream stream, T value) @@ -33,7 +33,7 @@ public static void Write(this Stream stream, T value) } /// - /// Reads a sequence of bytes representing the structure and moves the current position within the by the number of read bytes. + /// Reads a sequence that represents the structure and moves the current position of the by the number of read bytes. /// Считывает последовательность байт представляющих структуру и перемещает текущую позицию в вперед на число прочитанных байт. /// /// @@ -45,8 +45,8 @@ public static void Write(this Stream stream, T value) /// Поток, содержащий структуру . /// /// - /// The structure, if all bytes from stream have been read, otherwise the default value of structure. - /// Структура , если все байты из потока были прочитаны, иначе значение структуры по умолчанию. + /// The structure, if all bytes from have been read, otherwise the default value of structure. + /// Структура , если её байты из потока были прочитаны, иначе значение структуры по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) @@ -58,7 +58,7 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and return array of structures from the strem . + /// Reads and return array of structures from the . /// Прочитывает и возвращает массив всех структур из потока . /// /// @@ -70,7 +70,7 @@ public static T ReadOrDefault(this Stream stream) /// Поток, содержащий структуру . /// /// - /// The array with structures obtained from the stream . + /// The array with structures obtained from the . /// Массив с структурами полученными из потока . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From 5a058049320dd41ce21a57b7969956815f78b49b Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 17:06:25 +0600 Subject: [PATCH 10/55] ReadAll method - Docs --- csharp/Platform.IO/FileHelpers.cs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 37c86de..8e79951 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -24,6 +24,22 @@ public static class FileHelpers [MethodImpl(MethodImplOptions.AggressiveInlining)] public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); + /// + /// Reads and return structures from . + /// Считывает и возвращает все структуры из . + /// + /// + /// The structure type. + /// Тип являющийся структурой. + /// + /// + /// The path to the file, from which to read array of structures. + /// Путь к файлу, из которого нужно прочитать массив структур . + /// + /// + /// The structure value. + /// Значение структуры . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(string path) where T : struct From 4273e0e93845dc41b40fe8af5f3ce47b00c8f51d Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 22:53:36 +0600 Subject: [PATCH 11/55] FileHelpers - ReadFirstOrDefault method - Docs --- csharp/Platform.IO/FileHelpers.cs | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 8e79951..ba6dfd1 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -37,7 +37,7 @@ public static class FileHelpers /// Путь к файлу, из которого нужно прочитать массив структур . /// /// - /// The structure value. + /// The structure value. /// Значение структуры . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -48,6 +48,22 @@ public static T[] ReadAll(string path) return reader.ReadAll(); } + /// + /// Reads and returns struct from . + /// Считывае, и возвращает структуру из . + /// + /// + /// The structure type. + /// Тип являющийся структурой. + /// + /// + /// The path to the file, from which to read array of structures. + /// Путь к файлу, из которого нужно прочитать массив структур . + /// + /// + /// Struct if reading from was successfull, otherwise default struct. + /// Структура если чтение с было успешным, иначе структуру по умолчанию. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) where T : struct From 9527954f97caa0400316a163c47a403ac24af6f8 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 22:55:35 +0600 Subject: [PATCH 12/55] FileHelpers - ReadAllChars, ReadAll methods - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index ba6dfd1..5e051f3 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -14,7 +14,7 @@ public static class FileHelpers /// Читает весь текст и возвращает массив символов из . /// /// - /// The path to the file, from which to read the character array . + /// The path to the file, from which to read the character array. /// Путь к файлу, из которого нужно прочитать массив символов. /// /// @@ -25,7 +25,7 @@ public static class FileHelpers public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// - /// Reads and return structures from . + /// Reads and return all structures from . /// Считывает и возвращает все структуры из . /// /// @@ -34,7 +34,7 @@ public static class FileHelpers /// /// /// The path to the file, from which to read array of structures. - /// Путь к файлу, из которого нужно прочитать массив структур . + /// Путь к файлу, из которого нужно прочитать массив структур типа . /// /// /// The structure value. From b1f6e8dfb3ec7a8e211bd52b32578b1f968799cf Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 22:57:35 +0600 Subject: [PATCH 13/55] StreamExtensions - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 4578800..358f745 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -10,7 +10,8 @@ public static class StreamExtensions { /// /// Writes a sequence that represents the to the and moves the current position of the by the number of written bytes. - /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в нем вперед на число записанных байт. + /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперед + на число записанных байт. /// /// /// The structure type. @@ -45,7 +46,7 @@ public static void Write(this Stream stream, T value) /// Поток, содержащий структуру . /// /// - /// The structure, if all bytes from have been read, otherwise the default value of structure. + /// The structure, if its bytes from have been read, otherwise the default value of structure. /// Структура , если её байты из потока были прочитаны, иначе значение структуры по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -58,7 +59,7 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and return array of structures from the . + /// Reads and returns array of structures from the . /// Прочитывает и возвращает массив всех структур из потока . /// /// @@ -71,7 +72,7 @@ public static T ReadOrDefault(this Stream stream) /// /// /// The array with structures obtained from the . - /// Массив с структурами полученными из потока . + /// Массив с структурами прочитанными из потока . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(this Stream stream) From 3169b95d5143560653c34444b97db1124c7cbc4f Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 22:59:23 +0600 Subject: [PATCH 14/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 5e051f3..ef7e355 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -25,8 +25,8 @@ public static class FileHelpers public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// - /// Reads and return all structures from . - /// Считывает и возвращает все структуры из . + /// Reads and return all structures from . + /// Считывает и возвращает все структуры типа из . /// /// /// The structure type. @@ -38,7 +38,7 @@ public static class FileHelpers /// /// /// The structure value. - /// Значение структуры . + /// Значение структуры типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(string path) @@ -50,7 +50,7 @@ public static T[] ReadAll(string path) /// /// Reads and returns struct from . - /// Считывае, и возвращает структуру из . + /// Считывае, и возвращает структуру типа из . /// /// /// The structure type. @@ -58,11 +58,11 @@ public static T[] ReadAll(string path) /// /// /// The path to the file, from which to read array of structures. - /// Путь к файлу, из которого нужно прочитать массив структур . + /// Путь к файлу, из которого нужно прочитать массив структур типа . /// /// /// Struct if reading from was successfull, otherwise default struct. - /// Структура если чтение с было успешным, иначе структуру по умолчанию. + /// Структура типа если чтение с было успешным, иначе структуру типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) From 2eacae5d6ee9dbfa9ea7eb16848d242b57250e31 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 23:00:06 +0600 Subject: [PATCH 15/55] StreamExtensions - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 358f745..d0b9fe1 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -35,7 +35,7 @@ public static void Write(this Stream stream, T value) /// /// Reads a sequence that represents the structure and moves the current position of the by the number of read bytes. - /// Считывает последовательность байт представляющих структуру и перемещает текущую позицию в вперед на число прочитанных байт. + /// Считывает последовательность байт представляющих структуру типа и перемещает текущую позицию в вперед на число прочитанных байт. /// /// /// The structure type. @@ -47,7 +47,7 @@ public static void Write(this Stream stream, T value) /// /// /// The structure, if its bytes from have been read, otherwise the default value of structure. - /// Структура , если её байты из потока были прочитаны, иначе значение структуры по умолчанию. + /// Структура , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) From 9aa7537c335331a07be5a1d75902963263b2d8b5 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 6 Mar 2021 23:07:08 +0600 Subject: [PATCH 16/55] FileHelpers - ReadFirstOrDefault method - Docs - Correction --- csharp/Platform.IO/FileHelpers.cs | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index ef7e355..3372a73 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -57,7 +57,7 @@ public static T[] ReadAll(string path) /// Тип являющийся структурой. /// /// - /// The path to the file, from which to read array of structures. + /// The path to the file, from which to read the array of structures. /// Путь к файлу, из которого нужно прочитать массив структур типа . /// /// @@ -72,6 +72,22 @@ public static T ReadFirstOrDefault(string path) return fileStream?.ReadOrDefault() ?? default; } + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); From c6f0a0fd36b6a7f8c118887471492f502d38425d Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 22:01:49 +0600 Subject: [PATCH 17/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 3372a73..6e561f0 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -37,8 +37,8 @@ public static class FileHelpers /// Путь к файлу, из которого нужно прочитать массив структур типа . /// /// - /// The structure value. - /// Значение структуры типа . + /// The structures array. + /// Массив структур типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(string path) @@ -61,8 +61,8 @@ public static T[] ReadAll(string path) /// Путь к файлу, из которого нужно прочитать массив структур типа . /// /// - /// Struct if reading from was successfull, otherwise default struct. - /// Структура типа если чтение с было успешным, иначе структуру типа по умолчанию. + /// A struct valueif read from is successfull, otherwise the default struct. + /// Структура типа если чтение из прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) @@ -81,8 +81,8 @@ public static T ReadFirstOrDefault(string path) /// /// /// - /// - /// + /// The path to the file, that has to + /// Путь к файлу, который должен пройти валидацию. /// /// /// From 11663f0c215eaa12e0fe608135808a7fe3ba4c3f Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 22:07:19 +0600 Subject: [PATCH 18/55] StreamExtensions - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index d0b9fe1..3455d73 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -10,8 +10,7 @@ public static class StreamExtensions { /// /// Writes a sequence that represents the to the and moves the current position of the by the number of written bytes. - /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперед - на число записанных байт. + /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперед на число записанных байт. /// /// /// The structure type. @@ -42,12 +41,12 @@ public static void Write(this Stream stream, T value) /// Тип являющийся структурой. /// /// - /// A stream containing the structure. - /// Поток, содержащий структуру . + /// A stream containing the structure value. + /// Поток, содержащий значение структуры . /// /// - /// The structure, if its bytes from have been read, otherwise the default value of structure. - /// Структура , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. + /// The structure, if its bytes from the are read, otherwise the default value of the structure value. + /// Значение структуры , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) @@ -59,20 +58,20 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and returns array of structures from the . - /// Прочитывает и возвращает массив всех структур из потока . + /// Reads and returns array of structure values from the . + /// Прочитывает и возвращает массив всех значений структур типа из потока . /// /// /// The structure type. /// Тип являющийся структурой. /// /// - /// A stream containing the structure. - /// Поток, содержащий структуру . + /// A stream containing the structure value. + /// Поток, содержащий значение структуры типа . /// /// - /// The array with structures obtained from the . - /// Массив с структурами прочитанными из потока . + /// The array with structure values read from the . + /// Массив с значениями структур типа , прочитанными из потока . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(this Stream stream) From 7f94d6b3fa3d00e822da2d099322f1c7b688fe11 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 22:11:40 +0600 Subject: [PATCH 19/55] StreamExtensions - Docs - StreamExtensions class --- csharp/Platform.IO/StreamExtensions.cs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 3455d73..00e64f3 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -6,6 +6,10 @@ namespace Platform.IO { + /// + /// Provides a set of helper methods for objects. + /// Предоставляет набор вспомогательных методов для объектов . + /// public static class StreamExtensions { /// From b918c168023fb5d706843ecde7c9b041e3f61e3d Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 22:13:16 +0600 Subject: [PATCH 20/55] FileHelpers - Docs - FileHelpers class --- csharp/Platform.IO/FileHelpers.cs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 6e561f0..4c27185 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -7,6 +7,10 @@ namespace Platform.IO { + /// + /// Provides a set of helper methods for working with files. + /// Предоставляет набор вспомогательных методов для работы с файлами. + /// public static class FileHelpers { /// From 6c0705fd5f1ed314a4e4d0a0ff85e04056b8e701 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 23:02:14 +0600 Subject: [PATCH 21/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 4c27185..805ae3d 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -8,7 +8,7 @@ namespace Platform.IO { /// - /// Provides a set of helper methods for working with files. + /// Provides a set of helper methods to work with files. /// Предоставляет набор вспомогательных методов для работы с файлами. /// public static class FileHelpers @@ -29,7 +29,7 @@ public static class FileHelpers public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// - /// Reads and return all structures from . + /// Reads and returns all structures from . /// Считывает и возвращает все структуры типа из . /// /// @@ -54,19 +54,19 @@ public static T[] ReadAll(string path) /// /// Reads and returns struct from . - /// Считывае, и возвращает структуру типа из . + /// Считывает и возвращает структуру типа из . /// /// /// The structure type. /// Тип являющийся структурой. /// /// - /// The path to the file, from which to read the array of structures. - /// Путь к файлу, из которого нужно прочитать массив структур типа . + /// The path to the file, from which to read the value of structure. + /// Путь к файлу, из которого нужно прочитать значение структуры типа . /// /// - /// A struct valueif read from is successfull, otherwise the default struct. - /// Структура типа если чтение из прошло успешно, иначе значение структуры типа по умолчанию. + /// A struct value if read from is successfull, otherwise the default struct value. + /// Значение структуры типа если чтение из прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) @@ -85,7 +85,7 @@ public static T ReadFirstOrDefault(string path) /// /// /// - /// The path to the file, that has to + /// The path to the file, that has to pass the validation. /// Путь к файлу, который должен пройти валидацию. /// /// From 83eb0ace9307a8c9b5640cb7fbbbbc0946c95c52 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 23:08:17 +0600 Subject: [PATCH 22/55] StreamExtensions - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 00e64f3..b4666e3 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -7,13 +7,13 @@ namespace Platform.IO { /// - /// Provides a set of helper methods for objects. - /// Предоставляет набор вспомогательных методов для объектов . + /// Provides a set of extension methods for class instances. + /// Предоставляет набор методов расширения для эксземпляров класса . /// public static class StreamExtensions { /// - /// Writes a sequence that represents the to the and moves the current position of the by the number of written bytes. + /// Writes a byte sequence that represents the to the and moves the current position of the by the number of written bytes. /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперед на число записанных байт. /// /// @@ -37,8 +37,8 @@ public static void Write(this Stream stream, T value) } /// - /// Reads a sequence that represents the structure and moves the current position of the by the number of read bytes. - /// Считывает последовательность байт представляющих структуру типа и перемещает текущую позицию в вперед на число прочитанных байт. + /// Reads a byte sequence that represents the structure value and moves the current position of the by the number of read bytes. + /// Считывает последовательность байт представляющих значение структуры типа и перемещает текущую позицию в вперед на число прочитанных байт. /// /// /// The structure type. @@ -49,8 +49,8 @@ public static void Write(this Stream stream, T value) /// Поток, содержащий значение структуры . /// /// - /// The structure, if its bytes from the are read, otherwise the default value of the structure value. - /// Значение структуры , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. + /// The structure value, if its bytes from the are read, otherwise the default structure value. + /// Значение структуры типа , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) @@ -71,7 +71,7 @@ public static T ReadOrDefault(this Stream stream) /// /// /// A stream containing the structure value. - /// Поток, содержащий значение структуры типа . + /// Поток, содержащий значение структур типа . /// /// /// The array with structure values read from the . From b577f31f6da51e98ed2a206c20ca02947097cb4c Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 23:22:33 +0600 Subject: [PATCH 23/55] StreamExtensions - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index b4666e3..378682b 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -14,7 +14,7 @@ public static class StreamExtensions { /// /// Writes a byte sequence that represents the to the and moves the current position of the by the number of written bytes. - /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперед на число записанных байт. + /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперёд на число записанных байт. /// /// /// The structure type. From 7247e9ba5b358cb50a12ce4394960cd6541ad911 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 7 Mar 2021 23:39:44 +0600 Subject: [PATCH 24/55] StreamExtensions - Docs - Corrections --- csharp/Platform.IO/StreamExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 378682b..87284ce 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -70,8 +70,8 @@ public static T ReadOrDefault(this Stream stream) /// Тип являющийся структурой. /// /// - /// A stream containing the structure value. - /// Поток, содержащий значение структур типа . + /// A stream containing the structure values. + /// Поток, содержащий значения структур типа . /// /// /// The array with structure values read from the . From bebbe41470530d3807c9d04b6abf5babd8e161e2 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Thu, 11 Mar 2021 21:06:46 +0600 Subject: [PATCH 25/55] FileHelpers - GetValidFileStreamOrDefault - Docs --- csharp/Platform.IO/FileHelpers.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 805ae3d..e522027 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -65,7 +65,7 @@ public static T[] ReadAll(string path) /// Путь к файлу, из которого нужно прочитать значение структуры типа . /// /// - /// A struct value if read from is successfull, otherwise the default struct value. + /// A struct value if read from is successfull, otherwise the default struct value. /// Значение структуры типа если чтение из прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From 392dbc40b375e4a82b0cdcb71098db14a24acc21 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Thu, 11 Mar 2021 21:20:04 +0600 Subject: [PATCH 26/55] FileHelpers - ReadLastOrDefault - Docs --- csharp/Platform.IO/FileHelpers.cs | 32 +++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index e522027..0f36d27 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -95,6 +95,22 @@ public static T ReadFirstOrDefault(string path) [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); + /// + /// Validates the file from . + /// Валидирует файл по пути . + /// + /// + /// The path to the file, that has to pass the validation. + /// Путь к файлу, который должен пройти валидацию. + /// + /// + /// The size of the file to be in . + /// Размер файла, который должен находиться в . + /// + /// + /// A read only upon successfull validation, otherwise null. + /// доступный только для чтения в случае успешной валидации, иначе null. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path, int elementSize) { @@ -110,6 +126,22 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi return fileSize > 0 ? File.OpenRead(path) : null; } + /// + /// Reads and returns the last structure value from . + /// Считывает и возвращает последнее значение структуры типа из . + /// + /// + /// The structure type. + /// Тип являющийся структурой. + /// + /// + /// The path to the structure values. + /// Путь к файлу с значениями структур типа . + /// + /// + /// The structure value in case of success, otherwise the default structure value. + /// Значение структуры типа в случае успеха, иначе значение по умолчанию структуры типа . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadLastOrDefault(string path) where T : struct From 9526a04751df9a63c4e7c462ad652eec447f4891 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Thu, 11 Mar 2021 21:23:43 +0600 Subject: [PATCH 27/55] FileHelpers - GetValidFileStreamOrDefault(string path, int elementSize) - Docs - Expcetion comment --- csharp/Platform.IO/FileHelpers.cs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 0f36d27..2026254 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -121,6 +121,10 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi var fileSize = GetSize(path); if (fileSize % elementSize != 0) { + /// + /// Throws the error, if the file is not aligned to elements with size . + /// Выбрасывает ошибку, если файл не соответсвует элементу размером . + /// throw new InvalidOperationException($"File is not aligned to elements with size {elementSize}."); } return fileSize > 0 ? File.OpenRead(path) : null; From 702754bf0a37d2aed73b16e8385bc72827476d0d Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 12:25:39 +0600 Subject: [PATCH 28/55] FileHelpers - GetValidFileStreamOrDefault(string path) - Docs --- csharp/Platform.IO/FileHelpers.cs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 2026254..bb7b96d 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -77,20 +77,20 @@ public static T ReadFirstOrDefault(string path) } /// - /// - /// + /// Validates the file from . + /// Валидирует файл по пути . /// /// - /// - /// + /// The structure type. + /// Тип являющийся структурой. /// /// /// The path to the file, that has to pass the validation. /// Путь к файлу, который должен пройти валидацию. /// /// - /// - /// + /// A read only upon successfull validation, otherwise null. + /// доступный только для чтения в случае успешной валидации, иначе null. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); From cb1b3af500116ea2e930dacaca3b16133bcc1c43 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 12:46:57 +0600 Subject: [PATCH 29/55] FileHelpers - WriteFirst - Docs --- csharp/Platform.IO/FileHelpers.cs | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index bb7b96d..7ae029a 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -77,8 +77,8 @@ public static T ReadFirstOrDefault(string path) } /// - /// Validates the file from . - /// Валидирует файл по пути . + /// Validates the file from and returns its . + /// Валидирует файл по пути и возвращает его . /// /// /// The structure type. @@ -96,8 +96,8 @@ public static T ReadFirstOrDefault(string path) private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Validates the file from . - /// Валидирует файл по пути . + /// Validates the file from and returns its . + /// Валидирует файл по пути и возвращает его . /// /// /// The path to the file, that has to pass the validation. @@ -161,6 +161,22 @@ public static T ReadLastOrDefault(string path) return reader.ReadOrDefault(); } + /// + /// Writes structure values at the beginning of the . + /// Записывает значения структур типа в начало . + /// + /// + /// The structure type. + /// Тип являющийся структурой. + /// + /// + /// The path to the file to be changed. + /// Путь к файлу для изменения. + /// + /// + /// structure values to be written at the beginning of the . + /// Значения структур типа записываемых в начало . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void WriteFirst(string path, T value) where T : struct From 818ac7635f9c6ef62327b557e8309c369accabf7 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 12:49:54 +0600 Subject: [PATCH 30/55] FileHelpers - Docs - from path > from the path --- csharp/Platform.IO/FileHelpers.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 7ae029a..88261a9 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -29,7 +29,7 @@ public static class FileHelpers public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// - /// Reads and returns all structures from . + /// Reads and returns all structures from the . /// Считывает и возвращает все структуры типа из . /// /// @@ -53,7 +53,7 @@ public static T[] ReadAll(string path) } /// - /// Reads and returns struct from . + /// Reads and returns struct from the . /// Считывает и возвращает структуру типа из . /// /// @@ -77,7 +77,7 @@ public static T ReadFirstOrDefault(string path) } /// - /// Validates the file from and returns its . + /// Validates the file from the and returns its . /// Валидирует файл по пути и возвращает его . /// /// @@ -96,7 +96,7 @@ public static T ReadFirstOrDefault(string path) private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Validates the file from and returns its . + /// Validates the file from the and returns its . /// Валидирует файл по пути и возвращает его . /// /// @@ -131,7 +131,7 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi } /// - /// Reads and returns the last structure value from . + /// Reads and returns the last structure value from the . /// Считывает и возвращает последнее значение структуры типа из . /// /// From fe433ef406dc8bb2888e89b001bc8949ac20ea43 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 12:53:11 +0600 Subject: [PATCH 31/55] FileHelpers - WriteFirst - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 88261a9..5a9bff0 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -170,12 +170,12 @@ public static T ReadLastOrDefault(string path) /// Тип являющийся структурой. /// /// - /// The path to the file to be changed. - /// Путь к файлу для изменения. + /// The path to the file to be changed or created. + /// Путь к файлу для изменения или создания. /// /// /// structure values to be written at the beginning of the . - /// Значения структур типа записываемых в начало . + /// Значения структур типа , записываемых в начало . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void WriteFirst(string path, T value) From 17e310cdbed0cb0d50c0daf7d6675e5b69ce7494 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:19:22 +0600 Subject: [PATCH 32/55] FileHelpers - Append - Docs --- csharp/Platform.IO/FileHelpers.cs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 5a9bff0..36c85b5 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -186,6 +186,18 @@ public static void WriteFirst(string path, T value) writer.Write(value); } + /// + /// Opens or creates the file in and returns its with append mode and write access. + /// Открывает или создает файл в и возвращает его с модом добавления в конец и доступом записи. + /// + /// + /// The path to the file. + /// Путь к файлу. + /// + /// + /// The with append mode and write access. + /// с модом добавления в конец и доступом записи. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); From bf8973dd5443d4288f4a8b4a82644b8bb36ed209 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:23:13 +0600 Subject: [PATCH 33/55] FileHelpers - GetSize - Docs --- csharp/Platform.IO/FileHelpers.cs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 36c85b5..8bc7629 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -201,6 +201,18 @@ public static void WriteFirst(string path, T value) [MethodImpl(MethodImplOptions.AggressiveInlining)] public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); + /// + /// Returns the file size from if file exists, otherwise 0. + /// Возвращает размер файла в если тот существует, иначе 0. + /// + /// + /// File to get size. + /// Файл, размер которого нужно получить. + /// + /// + /// File size if file exists, otherwise 0. + /// Размер файла если файл существует, либо 0. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static long GetSize(string path) => File.Exists(path) ? new FileInfo(path).Length : 0; From 8770812fe1472c3918e9f5a860b226f1986f32e3 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:24:32 +0600 Subject: [PATCH 34/55] FileHelpers - GetSize - Docs - Path param correction --- csharp/Platform.IO/FileHelpers.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 8bc7629..3ea626b 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -206,8 +206,8 @@ public static void WriteFirst(string path, T value) /// Возвращает размер файла в если тот существует, иначе 0. /// /// - /// File to get size. - /// Файл, размер которого нужно получить. + /// The path to the file to get size. + /// Путь к файлу, размер которого нужно получить. /// /// /// File size if file exists, otherwise 0. From 8b910444c955672550731df2b9bae48e00172a9f Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:27:28 +0600 Subject: [PATCH 35/55] FileHelpers - Append - Docs - Correction --- csharp/Platform.IO/FileHelpers.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 3ea626b..af09c5d 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -191,8 +191,8 @@ public static void WriteFirst(string path, T value) /// Открывает или создает файл в и возвращает его с модом добавления в конец и доступом записи. /// /// - /// The path to the file. - /// Путь к файлу. + /// The path to the file to open. + /// Путь к файлу, который нужно открыть. /// /// /// The with append mode and write access. From 6468a9a09c732da3ebbec817d715cbb8de12a2a0 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:32:33 +0600 Subject: [PATCH 36/55] FileHelpers - SetSize - Docs --- csharp/Platform.IO/FileHelpers.cs | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index af09c5d..89cd6c1 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -191,8 +191,8 @@ public static void WriteFirst(string path, T value) /// Открывает или создает файл в и возвращает его с модом добавления в конец и доступом записи. /// /// - /// The path to the file to open. - /// Путь к файлу, который нужно открыть. + /// The path to the file to open or create. + /// Путь к файлу, который нужно открыть или создать. /// /// /// The with append mode and write access. @@ -216,6 +216,18 @@ public static void WriteFirst(string path, T value) [MethodImpl(MethodImplOptions.AggressiveInlining)] public static long GetSize(string path) => File.Exists(path) ? new FileInfo(path).Length : 0; + /// + /// Sets the file size from the . + /// Устанавливает размер файлу из . + /// + /// + /// The path to the file to be resized. + /// Путь к файлу, размер которого нужно изменить. + /// + /// + /// The size that will be asigned to the file from . + /// Размер который будет присвоен файлу из . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void SetSize(string path, long size) { From 4b6428cd9b246739eb3c68179dbcdce3e879d28b Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:42:01 +0600 Subject: [PATCH 37/55] FileHelpers - DeleteAll(string directory, string SearchPattern, SearchOption searchOption) - Docs --- csharp/Platform.IO/FileHelpers.cs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 89cd6c1..335740d 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -244,6 +244,22 @@ public static void SetSize(string path, long size) [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); + /// + /// Cleans up all files from the according to the and the . + /// Очищает все файлы из в соотвествии с и . + /// + /// + /// Directory to be cleanuped. + /// Директория для очистки. + /// + /// + /// Search pattern for files in the . + /// Шаблон поиска для файлов в . + /// + /// + /// Specifies whether to seatch the current , or the current and all subdirectories. + /// Указывает следует ли искать только в текущей директории , или также в субдиректориях. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern, SearchOption searchOption) { From 683c88ea527ec46bc7b6f17b4e1a5fab67d94754 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:45:59 +0600 Subject: [PATCH 38/55] FileHelpers - DeleteAll(string directory, string SearchPattern) - Docs correction --- csharp/Platform.IO/FileHelpers.cs | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 335740d..e267fe8 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -241,6 +241,18 @@ public static void SetSize(string path, long size) [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory) => DeleteAll(directory, "*"); + /// + /// Cleans up all files from the according to the . + /// Очищает все файлы из директории в соотвествии с . + /// + /// + /// Directory to be cleaned. + /// Директория для очистки. + /// + /// + /// Search pattern for files in the . + /// Шаблон поиска для файлов в . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); @@ -249,7 +261,7 @@ public static void SetSize(string path, long size) /// Очищает все файлы из в соотвествии с и . /// /// - /// Directory to be cleanuped. + /// Directory to be cleaned. /// Директория для очистки. /// /// From 291c972949d16164c5b60707a20b07f2d63ca2f5 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:46:35 +0600 Subject: [PATCH 39/55] FileHelpers - DeleteAll(string directory, string SearchPattern, SearchOption searchOption) - Docs correction --- csharp/Platform.IO/FileHelpers.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index e267fe8..cabbe3b 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -258,7 +258,7 @@ public static void SetSize(string path, long size) /// /// Cleans up all files from the according to the and the . - /// Очищает все файлы из в соотвествии с и . + /// Очищает все файлы из директории в соотвествии с и . /// /// /// Directory to be cleaned. @@ -269,7 +269,7 @@ public static void SetSize(string path, long size) /// Шаблон поиска для файлов в . /// /// - /// Specifies whether to seatch the current , or the current and all subdirectories. + /// Specifies whether to search the current , or the current and all subdirectories. /// Указывает следует ли искать только в текущей директории , или также в субдиректориях. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From 3a159b65597d7711e0937f584bd3b6aa7b477a02 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:49:12 +0600 Subject: [PATCH 40/55] FileHelpers - DeleteAll(string directory) - Docs --- csharp/Platform.IO/FileHelpers.cs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index cabbe3b..4a3fb23 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -238,6 +238,14 @@ public static void SetSize(string path, long size) } } + /// + /// Removes all files from the . + /// Удаляет все файлы из директории . + /// + /// + /// Directory to be cleaned. + /// Директория для очистки. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory) => DeleteAll(directory, "*"); From b82b1daec7de921bbaf401d3e1f93b5869a7a171 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 12 Mar 2021 13:49:51 +0600 Subject: [PATCH 41/55] FileHelpers - DeleteAll - Docs corrections --- csharp/Platform.IO/FileHelpers.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 4a3fb23..e8b5b14 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -250,8 +250,8 @@ public static void SetSize(string path, long size) public static void DeleteAll(string directory) => DeleteAll(directory, "*"); /// - /// Cleans up all files from the according to the . - /// Очищает все файлы из директории в соотвествии с . + /// Removes up all files from the according to the . + /// Удаляет все файлы из директории в соотвествии с . /// /// /// Directory to be cleaned. @@ -265,8 +265,8 @@ public static void SetSize(string path, long size) public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); /// - /// Cleans up all files from the according to the and the . - /// Очищает все файлы из директории в соотвествии с и . + /// Removes up all files from the according to the and the . + /// Удаляет все файлы из директории в соотвествии с и . /// /// /// Directory to be cleaned. From 4301fd007b7785b925f584124d105183fd344094 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 13 Mar 2021 14:52:05 +0600 Subject: [PATCH 42/55] FileHelpers, StreamExtensions - Docs - A lot of corrections --- csharp/Platform.IO/FileHelpers.cs | 132 ++++++++++++------------- csharp/Platform.IO/StreamExtensions.cs | 22 ++--- 2 files changed, 77 insertions(+), 77 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index e8b5b14..e6974be 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -14,35 +14,35 @@ namespace Platform.IO public static class FileHelpers { /// - /// Reads all the text and returns character array from the . - /// Читает весь текст и возвращает массив символов из . + /// Reads all the text and returns character array from the file at . + /// Читает весь текст и возвращает массив символов из файла по пути. /// /// /// The path to the file, from which to read the character array. /// Путь к файлу, из которого нужно прочитать массив символов. /// /// - /// The character array from the . - /// Массив символов из . + /// The character array from the file at . + /// Массив символов из файла по пути . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// - /// Reads and returns all structures from the . - /// Считывает и возвращает все структуры типа из . + /// Reads and returns all structure values from the file at . + /// Считывает и возвращает все значения структур типа из файла по пути . /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// - /// The path to the file, from which to read array of structures. - /// Путь к файлу, из которого нужно прочитать массив структур типа . + /// The path to the file, from which to read array of structure values. + /// Путь к файлу, из которого нужно прочитать массив значений структур типа . /// /// - /// The structures array. - /// Массив структур типа . + /// The structure values array. + /// Массив значений структур типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T[] ReadAll(string path) @@ -53,20 +53,20 @@ public static T[] ReadAll(string path) } /// - /// Reads and returns struct from the . - /// Считывает и возвращает структуру типа из . + /// Reads and returns the structure value from the file at . + /// Считывает и возвращает значение структуры типа из файла по пути . /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// - /// The path to the file, from which to read the value of structure. + /// The path to the file, from which to read the structure value. /// Путь к файлу, из которого нужно прочитать значение структуры типа . /// /// - /// A struct value if read from is successfull, otherwise the default struct value. - /// Значение структуры типа если чтение из прошло успешно, иначе значение структуры типа по умолчанию. + /// The structure value if read from the file at is successfull, otherwise the default structure value. + /// Значение структуры типа если чтение из файла по пути прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) @@ -77,40 +77,44 @@ public static T ReadFirstOrDefault(string path) } /// - /// Validates the file from the and returns its . - /// Валидирует файл по пути и возвращает его . + /// Returns the with opened file from the file at if its size is a multiple of the structure value size, otherwise . + /// Возвращает с открытым файлом из файла по пути , если его размер кратен размеру значения структуры типа , а иначе . /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// - /// The path to the file, that has to pass the validation. - /// Путь к файлу, который должен пройти валидацию. + /// The path to the file to be scanned. + /// Путь к проверяемому файлу. /// /// - /// A read only upon successfull validation, otherwise null. - /// доступный только для чтения в случае успешной валидации, иначе null. + /// A read-only in the case of successful check, otherwise . + /// открытый для чтения в случае успешной проверки, а иначе . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Validates the file from the and returns its . - /// Валидирует файл по пути и возвращает его . + /// Returns the with opened file from the file at if its size is a multiple of the required , otherwise . + /// Возвращает с открытым файлом из файла по пути, если его размер кратен требуемому размеру элементов , а иначе . /// /// - /// The path to the file, that has to pass the validation. - /// Путь к файлу, который должен пройти валидацию. + /// The path to the file to be scanned. + /// Путь к проверяемому файлу. /// /// - /// The size of the file to be in . - /// Размер файла, который должен находиться в . + /// Required size of elements located in the file at . + /// Требуемый размер элементов, находящихся в файле по пути . /// /// - /// A read only upon successfull validation, otherwise null. - /// доступный только для чтения в случае успешной валидации, иначе null. + /// A read-only in the case of successful check, otherwise . + /// открытый для чтения в случае успешной проверки, а иначе . /// + /// + /// The size of the file at is not a multiple of the required . + /// Размер файла по пути не кратен требуемому размеру элемента . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path, int elementSize) { @@ -121,30 +125,26 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi var fileSize = GetSize(path); if (fileSize % elementSize != 0) { - /// - /// Throws the error, if the file is not aligned to elements with size . - /// Выбрасывает ошибку, если файл не соответсвует элементу размером . - /// throw new InvalidOperationException($"File is not aligned to elements with size {elementSize}."); } return fileSize > 0 ? File.OpenRead(path) : null; } /// - /// Reads and returns the last structure value from the . - /// Считывает и возвращает последнее значение структуры типа из . + /// Reads and returns the last structure value from the file at . + /// Считывает и возвращает последнее значение структуры типа из файла по пути . /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// /// The path to the structure values. /// Путь к файлу с значениями структур типа . /// /// - /// The structure value in case of success, otherwise the default structure value. - /// Значение структуры типа в случае успеха, иначе значение по умолчанию структуры типа . + /// The last structure value from the file at in the case of success, otherwise the default structure value. + /// Значение структуры типа из файла по пути в случае успеха, иначе значение по умолчанию структуры типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadLastOrDefault(string path) @@ -162,20 +162,20 @@ public static T ReadLastOrDefault(string path) } /// - /// Writes structure values at the beginning of the . - /// Записывает значения структур типа в начало . + /// Writes structure values at the beginning of the file at . + /// Записывает значения структур типа в начало файла по пути . /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// /// The path to the file to be changed or created. /// Путь к файлу для изменения или создания. /// /// - /// structure values to be written at the beginning of the . - /// Значения структур типа , записываемых в начало . + /// structure values to be written at the beginning of the file at . + /// Значения структур типа , записываемых в начало файла по пути . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void WriteFirst(string path, T value) @@ -187,8 +187,8 @@ public static void WriteFirst(string path, T value) } /// - /// Opens or creates the file in and returns its with append mode and write access. - /// Открывает или создает файл в и возвращает его с модом добавления в конец и доступом записи. + /// Opens or creates the file at and returns its with append mode and write access. + /// Открывает или создает файл по пути и возвращает его с модом добавления в конец и доступом записи. /// /// /// The path to the file to open or create. @@ -202,31 +202,31 @@ public static void WriteFirst(string path, T value) public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); /// - /// Returns the file size from if file exists, otherwise 0. - /// Возвращает размер файла в если тот существует, иначе 0. + /// Returns the size of file at if file exists, otherwise 0. + /// Возвращает размер файла по пути если тот существует, иначе 0. /// /// /// The path to the file to get size. /// Путь к файлу, размер которого нужно получить. /// /// - /// File size if file exists, otherwise 0. - /// Размер файла если файл существует, либо 0. + /// Size of file at if it exists, otherwise 0. + /// Размер файла если файл по пути существует, либо 0. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static long GetSize(string path) => File.Exists(path) ? new FileInfo(path).Length : 0; /// - /// Sets the file size from the . - /// Устанавливает размер файлу из . + /// Sets the for the file at . + /// Устанавливает размер файлу по пути . /// /// /// The path to the file to be resized. /// Путь к файлу, размер которого нужно изменить. /// /// - /// The size that will be asigned to the file from . - /// Размер который будет присвоен файлу из . + /// The size to assign to the file at . + /// Размер который будет присвоен файлу по пути . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void SetSize(string path, long size) @@ -243,41 +243,41 @@ public static void SetSize(string path, long size) /// Удаляет все файлы из директории . /// /// - /// Directory to be cleaned. + /// The directory to be cleaned. /// Директория для очистки. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory) => DeleteAll(directory, "*"); /// - /// Removes up all files from the according to the . - /// Удаляет все файлы из директории в соотвествии с . + /// Removes all files from the according to the . + /// Удаляет все файлы из директории в соотвествии с шаблоном поиска . /// /// - /// Directory to be cleaned. + /// The directory to be cleaned. /// Директория для очистки. /// /// /// Search pattern for files in the . - /// Шаблон поиска для файлов в . + /// Шаблон поиска для файлов в директории . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); /// - /// Removes up all files from the according to the and the . - /// Удаляет все файлы из директории в соотвествии с и . + /// Removes all files from the directory according to the and the . + /// Удаляет все файлы из директории в соотвествии с шаблоном поиска и настройкой поиска . /// /// - /// Directory to be cleaned. + /// The directory to be cleaned. /// Директория для очистки. /// /// /// Search pattern for files in the . - /// Шаблон поиска для файлов в . + /// Шаблон поиска для файлов в директории . /// /// - /// Specifies whether to search the current , or the current and all subdirectories. + /// Specifies whether to search only in the current , or also in subdirectories. /// Указывает следует ли искать только в текущей директории , или также в субдиректориях. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 87284ce..a1bc958 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -13,20 +13,20 @@ namespace Platform.IO public static class StreamExtensions { /// - /// Writes a byte sequence that represents the to the and moves the current position of the by the number of written bytes. - /// Записывает последовательность байт представляющую в поток и перемещает текущую позицию в вперёд на число записанных байт. + /// Writes a byte sequence that represents the to the and moves the current position of the by the number of written bytes. + /// Записывает последовательность байт представляющую типа в поток и перемещает текущую позицию в вперёд на число записанных байт. /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// /// A stream to write to. /// Поток, в который осуществляется запись. /// /// - /// The struct value to be written to the . - /// Значение структуры которое будет записано в поток . + /// The structure value to be written to the . + /// Значение структуры типа которое будет записано в поток . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void Write(this Stream stream, T value) @@ -38,19 +38,19 @@ public static void Write(this Stream stream, T value) /// /// Reads a byte sequence that represents the structure value and moves the current position of the by the number of read bytes. - /// Считывает последовательность байт представляющих значение структуры типа и перемещает текущую позицию в вперед на число прочитанных байт. + /// Считывает последовательность байт представляющих значение структуры типа и перемещает текущую позицию в потоке вперёд на число прочитанных байт. /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// /// A stream containing the structure value. - /// Поток, содержащий значение структуры . + /// Поток, содержащий значение структуры типа . /// /// /// The structure value, if its bytes from the are read, otherwise the default structure value. - /// Значение структуры типа , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. + /// Значение структуры типа , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadOrDefault(this Stream stream) @@ -62,12 +62,12 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and returns array of structure values from the . + /// Reads and returns the array of structure values from the . /// Прочитывает и возвращает массив всех значений структур типа из потока . /// /// /// The structure type. - /// Тип являющийся структурой. + /// Тип структуры. /// /// /// A stream containing the structure values. From 034fac70ba80bfea1346203b6d11e8c3310146da Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Mon, 15 Mar 2021 15:15:08 +0600 Subject: [PATCH 43/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index e6974be..8c2b2ce 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -85,7 +85,7 @@ public static T ReadFirstOrDefault(string path) /// Тип структуры. /// /// - /// The path to the file to be scanned. + /// The path to the file to validate. /// Путь к проверяемому файлу. /// /// @@ -96,8 +96,8 @@ public static T ReadFirstOrDefault(string path) private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Returns the with opened file from the file at if its size is a multiple of the required , otherwise . - /// Возвращает с открытым файлом из файла по пути, если его размер кратен требуемому размеру элементов , а иначе . + /// Returns the opened for reading from the file at if its size is a multiple of the required , otherwise . + /// Возвращает открытый для чтения из файла по пути, если его размер кратен требуемому размеру элементов , а иначе . /// /// /// The path to the file to be scanned. From fd1172cd1d1c008ced2ce3b34371f9831ded53b1 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Fri, 19 Mar 2021 18:36:13 +0600 Subject: [PATCH 44/55] FileHelpers, StreamExtensions - Docs - A few corrections --- csharp/Platform.IO/FileHelpers.cs | 2 +- csharp/Platform.IO/StreamExtensions.cs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 8c2b2ce..1910a0f 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -37,7 +37,7 @@ public static class FileHelpers /// Тип структуры. /// /// - /// The path to the file, from which to read array of structure values. + /// The path to the file, from which to read structure values array. /// Путь к файлу, из которого нужно прочитать массив значений структур типа . /// /// diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index a1bc958..ec550ca 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -62,7 +62,7 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and returns the array of structure values from the . + /// Reads and returns the structure values array from the . /// Прочитывает и возвращает массив всех значений структур типа из потока . /// /// @@ -74,7 +74,7 @@ public static T ReadOrDefault(this Stream stream) /// Поток, содержащий значения структур типа . /// /// - /// The array with structure values read from the . + /// The structure values array read from the . /// Массив с значениями структур типа , прочитанными из потока . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From d44471db10f23e2e96de6de55a57a29a25e0129a Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 21 Mar 2021 10:59:30 +0600 Subject: [PATCH 45/55] =?UTF-8?q?FileHelpers=20-=20Docs=20-=20Corrections?= =?UTF-8?q?=20-=20=D0=A4=D0=B0=D0=B9=D0=BB=D0=B0=20=D0=BF=D0=BE=20=D0=BF?= =?UTF-8?q?=D1=83=D1=82=D0=B8=20path=20->=20=D0=A4=D0=B0=D0=B9=D0=BB=D0=B0?= =?UTF-8?q?=20=D0=BD=D0=B0=D1=85=D0=BE=D0=B4=D1=8F=D1=89=D0=B5=D0=B3=D0=BE?= =?UTF-8?q?=D1=81=D1=8F=20=D0=B2=20path?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- csharp/Platform.IO/FileHelpers.cs | 36 +++++++++++++++---------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 1910a0f..0d43881 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -15,7 +15,7 @@ public static class FileHelpers { /// /// Reads all the text and returns character array from the file at . - /// Читает весь текст и возвращает массив символов из файла по пути. + /// Читает весь текст и возвращает массив символов из файла находящегося в . /// /// /// The path to the file, from which to read the character array. @@ -23,14 +23,14 @@ public static class FileHelpers /// /// /// The character array from the file at . - /// Массив символов из файла по пути . + /// Массив символов из файла находящегося в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// /// Reads and returns all structure values from the file at . - /// Считывает и возвращает все значения структур типа из файла по пути . + /// Считывает и возвращает все значения структур типа из файла находящегося в . /// /// /// The structure type. @@ -54,7 +54,7 @@ public static T[] ReadAll(string path) /// /// Reads and returns the structure value from the file at . - /// Считывает и возвращает значение структуры типа из файла по пути . + /// Считывает и возвращает значение структуры типа из файла находящегося в . /// /// /// The structure type. @@ -66,7 +66,7 @@ public static T[] ReadAll(string path) /// /// /// The structure value if read from the file at is successfull, otherwise the default structure value. - /// Значение структуры типа если чтение из файла по пути прошло успешно, иначе значение структуры типа по умолчанию. + /// Значение структуры типа если чтение из файла находящегося в прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) @@ -78,7 +78,7 @@ public static T ReadFirstOrDefault(string path) /// /// Returns the with opened file from the file at if its size is a multiple of the structure value size, otherwise . - /// Возвращает с открытым файлом из файла по пути , если его размер кратен размеру значения структуры типа , а иначе . + /// Возвращает с открытым файлом из файла находящегося в , если его размер кратен размеру значения структуры типа , а иначе . /// /// /// The structure type. @@ -97,7 +97,7 @@ public static T ReadFirstOrDefault(string path) /// /// Returns the opened for reading from the file at if its size is a multiple of the required , otherwise . - /// Возвращает открытый для чтения из файла по пути, если его размер кратен требуемому размеру элементов , а иначе . + /// Возвращает открытый для чтения из файла находящегося в , если его размер кратен требуемому размеру элементов , а иначе . /// /// /// The path to the file to be scanned. @@ -105,7 +105,7 @@ public static T ReadFirstOrDefault(string path) /// /// /// Required size of elements located in the file at . - /// Требуемый размер элементов, находящихся в файле по пути . + /// Требуемый размер элементов, находящихся в файленаходящегося в . /// /// /// A read-only in the case of successful check, otherwise . @@ -113,7 +113,7 @@ public static T ReadFirstOrDefault(string path) /// /// /// The size of the file at is not a multiple of the required . - /// Размер файла по пути не кратен требуемому размеру элемента . + /// Размер файла находящегося в не кратен требуемому размеру элемента . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path, int elementSize) @@ -132,7 +132,7 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi /// /// Reads and returns the last structure value from the file at . - /// Считывает и возвращает последнее значение структуры типа из файла по пути . + /// Считывает и возвращает последнее значение структуры типа из файла находящегося в . /// /// /// The structure type. @@ -144,7 +144,7 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi /// /// /// The last structure value from the file at in the case of success, otherwise the default structure value. - /// Значение структуры типа из файла по пути в случае успеха, иначе значение по умолчанию структуры типа . + /// Значение структуры типа из файла находящегося в в случае успеха, иначе значение по умолчанию структуры типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadLastOrDefault(string path) @@ -163,7 +163,7 @@ public static T ReadLastOrDefault(string path) /// /// Writes structure values at the beginning of the file at . - /// Записывает значения структур типа в начало файла по пути . + /// Записывает значения структур типа в начало файла находящегося в . /// /// /// The structure type. @@ -175,7 +175,7 @@ public static T ReadLastOrDefault(string path) /// /// /// structure values to be written at the beginning of the file at . - /// Значения структур типа , записываемых в начало файла по пути . + /// Значения структур типа , записываемых в начало файла находящегося в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void WriteFirst(string path, T value) @@ -188,7 +188,7 @@ public static void WriteFirst(string path, T value) /// /// Opens or creates the file at and returns its with append mode and write access. - /// Открывает или создает файл по пути и возвращает его с модом добавления в конец и доступом записи. + /// Открывает или создает файл находящегося в и возвращает его с модом добавления в конец и доступом записи. /// /// /// The path to the file to open or create. @@ -203,7 +203,7 @@ public static void WriteFirst(string path, T value) /// /// Returns the size of file at if file exists, otherwise 0. - /// Возвращает размер файла по пути если тот существует, иначе 0. + /// Возвращает размер файла находящегося в если тот существует, иначе 0. /// /// /// The path to the file to get size. @@ -211,14 +211,14 @@ public static void WriteFirst(string path, T value) /// /// /// Size of file at if it exists, otherwise 0. - /// Размер файла если файл по пути существует, либо 0. + /// Размер файла если файл находящийся в существует, либо 0. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static long GetSize(string path) => File.Exists(path) ? new FileInfo(path).Length : 0; /// /// Sets the for the file at . - /// Устанавливает размер файлу по пути . + /// Устанавливает размер файлу находящегося в . /// /// /// The path to the file to be resized. @@ -226,7 +226,7 @@ public static void WriteFirst(string path, T value) /// /// /// The size to assign to the file at . - /// Размер который будет присвоен файлу по пути . + /// Размер который будет присвоен файлу находящегося в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void SetSize(string path, long size) From ed281f51591e44f59cca5b3de4201c9751c07f3e Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 21 Mar 2021 20:44:24 +0600 Subject: [PATCH 46/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 0d43881..f33a23c 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -77,8 +77,8 @@ public static T ReadFirstOrDefault(string path) } /// - /// Returns the with opened file from the file at if its size is a multiple of the structure value size, otherwise . - /// Возвращает с открытым файлом из файла находящегося в , если его размер кратен размеру значения структуры типа , а иначе . + /// Returns the with opened file from the file at if file exists, not empty and its size is a multiple of the structure size, otherwise . + /// Возвращает с открытым файлом из файла находящегося в , если файл существует, не пуст и его размер кратен размеру структуры типа , а иначе . /// /// /// The structure type. @@ -89,31 +89,31 @@ public static T ReadFirstOrDefault(string path) /// Путь к проверяемому файлу. /// /// - /// A read-only in the case of successful check, otherwise . + /// A opened for reading in the case of successful check, otherwise . /// открытый для чтения в случае успешной проверки, а иначе . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Returns the opened for reading from the file at if its size is a multiple of the required , otherwise . - /// Возвращает открытый для чтения из файла находящегося в , если его размер кратен требуемому размеру элементов , а иначе . + /// Returns the opened for reading from the file at if file exists, not empty and its size is a multiple of the required , otherwise . + /// Возвращает открытый для чтения из файла находящегося в , если файл существует, не пуст и его размер кратен размеру , а иначе . /// /// - /// The path to the file to be scanned. + /// The path to the file to validate. /// Путь к проверяемому файлу. /// /// /// Required size of elements located in the file at . - /// Требуемый размер элементов, находящихся в файленаходящегося в . + /// Требуемый размер элементов, находящихся в файле находящегося в . /// /// - /// A read-only in the case of successful check, otherwise . + /// A opened for reading in the case of successful check, otherwise . /// открытый для чтения в случае успешной проверки, а иначе . /// /// /// The size of the file at is not a multiple of the required . - /// Размер файла находящегося в не кратен требуемому размеру элемента . + /// Размер файла находящегося в не кратен требуемому размеру . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path, int elementSize) From 46e4cbde40022421dbb50293a097c558dc5f4592 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 21 Mar 2021 21:00:19 +0600 Subject: [PATCH 47/55] FileHelpers - Docs - Correction --- csharp/Platform.IO/FileHelpers.cs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index f33a23c..fa5063d 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -92,6 +92,10 @@ public static T ReadFirstOrDefault(string path) /// A opened for reading in the case of successful check, otherwise . /// открытый для чтения в случае успешной проверки, а иначе . /// + /// + /// The size of the file at is not a multiple of the required . + /// Размер файла находящегося в не кратен требуемому размеру . + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); From 9c1605001798df06bdc96873c4325a59d54e1f15 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sun, 21 Mar 2021 23:20:35 +0600 Subject: [PATCH 48/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 56 +++++++++++++++---------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index fa5063d..b777fab 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -14,7 +14,7 @@ namespace Platform.IO public static class FileHelpers { /// - /// Reads all the text and returns character array from the file at . + /// Reads all the text and returns character array from the file at the . /// Читает весь текст и возвращает массив символов из файла находящегося в . /// /// @@ -22,14 +22,14 @@ public static class FileHelpers /// Путь к файлу, из которого нужно прочитать массив символов. /// /// - /// The character array from the file at . + /// The character array from the file at the . /// Массив символов из файла находящегося в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static char[] ReadAllChars(string path) => File.ReadAllText(path).ToCharArray(); /// - /// Reads and returns all structure values from the file at . + /// Reads and returns all structure values from the file at the . /// Считывает и возвращает все значения структур типа из файла находящегося в . /// /// @@ -53,7 +53,7 @@ public static T[] ReadAll(string path) } /// - /// Reads and returns the structure value from the file at . + /// Reads and returns the structure value from the file at the . /// Считывает и возвращает значение структуры типа из файла находящегося в . /// /// @@ -65,8 +65,8 @@ public static T[] ReadAll(string path) /// Путь к файлу, из которого нужно прочитать значение структуры типа . /// /// - /// The structure value if read from the file at is successfull, otherwise the default structure value. - /// Значение структуры типа если чтение из файла находящегося в прошло успешно, иначе значение структуры типа по умолчанию. + /// The structure value if read from the file at the is successful, otherwise the default structure value. + /// Значение структуры типа если чтение из файла находящегося в прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadFirstOrDefault(string path) @@ -77,8 +77,8 @@ public static T ReadFirstOrDefault(string path) } /// - /// Returns the with opened file from the file at if file exists, not empty and its size is a multiple of the structure size, otherwise . - /// Возвращает с открытым файлом из файла находящегося в , если файл существует, не пуст и его размер кратен размеру структуры типа , а иначе . + /// Returns the opened for reading from the file at the if the file exists, not empty and its size is a multiple of the structure size, otherwise . + /// Возвращает открытый для чтения из файла находящегося в , если файл существует, не пуст и его размер кратен размеру структуры типа , а иначе . /// /// /// The structure type. @@ -93,22 +93,22 @@ public static T ReadFirstOrDefault(string path) /// открытый для чтения в случае успешной проверки, а иначе . /// /// - /// The size of the file at is not a multiple of the required . - /// Размер файла находящегося в не кратен требуемому размеру . + /// The size of the file at the is not a multiple of the required . + /// Размер файла находящегося в не кратен требуемому . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Returns the opened for reading from the file at if file exists, not empty and its size is a multiple of the required , otherwise . - /// Возвращает открытый для чтения из файла находящегося в , если файл существует, не пуст и его размер кратен размеру , а иначе . + /// Returns the opened for reading from the file at the if the file exists, not empty and its size is a multiple of the required , otherwise . + /// Возвращает открытый для чтения из файла находящегося в , если файл существует, не пуст и его размер кратен , а иначе . /// /// /// The path to the file to validate. /// Путь к проверяемому файлу. /// /// - /// Required size of elements located in the file at . + /// Required size of elements located in the file at the . /// Требуемый размер элементов, находящихся в файле находящегося в . /// /// @@ -116,8 +116,8 @@ public static T ReadFirstOrDefault(string path) /// открытый для чтения в случае успешной проверки, а иначе . /// /// - /// The size of the file at is not a multiple of the required . - /// Размер файла находящегося в не кратен требуемому размеру . + /// The size of the file at the is not a multiple of the required . + /// Размер файла находящегося в не кратен требуемому . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] private static FileStream GetValidFileStreamOrDefault(string path, int elementSize) @@ -135,7 +135,7 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi } /// - /// Reads and returns the last structure value from the file at . + /// Reads and returns the last structure value from the file at the . /// Считывает и возвращает последнее значение структуры типа из файла находящегося в . /// /// @@ -147,8 +147,8 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi /// Путь к файлу с значениями структур типа . /// /// - /// The last structure value from the file at in the case of success, otherwise the default structure value. - /// Значение структуры типа из файла находящегося в в случае успеха, иначе значение по умолчанию структуры типа . + /// The last structure value from the file at the in the case of successful read, otherwise the default structure value. + /// Значение структуры типа из файла находящегося в в случае успешного чтения, иначе значение по умолчанию структуры типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static T ReadLastOrDefault(string path) @@ -166,8 +166,8 @@ public static T ReadLastOrDefault(string path) } /// - /// Writes structure values at the beginning of the file at . - /// Записывает значения структур типа в начало файла находящегося в . + /// Writes structure value at the beginning of the file at the . + /// Записывает значение структуры типа в начало файла находящегося в . /// /// /// The structure type. @@ -175,11 +175,11 @@ public static T ReadLastOrDefault(string path) /// /// /// The path to the file to be changed or created. - /// Путь к файлу для изменения или создания. + /// Путь к файлу, который будет изменён или создан. /// /// - /// structure values to be written at the beginning of the file at . - /// Значения структур типа , записываемых в начало файла находящегося в . + /// structure value to be written at the beginning of the file at the . + /// Значение структуры типа , записываемое в начало файла находящегося в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void WriteFirst(string path, T value) @@ -191,7 +191,7 @@ public static void WriteFirst(string path, T value) } /// - /// Opens or creates the file at and returns its with append mode and write access. + /// Opens or creates the file at the and returns its with append mode and write access. /// Открывает или создает файл находящегося в и возвращает его с модом добавления в конец и доступом записи. /// /// @@ -206,7 +206,7 @@ public static void WriteFirst(string path, T value) public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); /// - /// Returns the size of file at if file exists, otherwise 0. + /// Returns the size of file at the if file exists, otherwise 0. /// Возвращает размер файла находящегося в если тот существует, иначе 0. /// /// @@ -214,14 +214,14 @@ public static void WriteFirst(string path, T value) /// Путь к файлу, размер которого нужно получить. /// /// - /// Size of file at if it exists, otherwise 0. + /// Size of file at the if it exists, otherwise 0. /// Размер файла если файл находящийся в существует, либо 0. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static long GetSize(string path) => File.Exists(path) ? new FileInfo(path).Length : 0; /// - /// Sets the for the file at . + /// Sets the for the file at the . /// Устанавливает размер файлу находящегося в . /// /// @@ -229,7 +229,7 @@ public static void WriteFirst(string path, T value) /// Путь к файлу, размер которого нужно изменить. /// /// - /// The size to assign to the file at . + /// The size to assign to the file at the . /// Размер который будет присвоен файлу находящегося в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From 15fa3f991df25f590ce65444001ba8da7776bbe0 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Wed, 24 Mar 2021 12:09:43 +0600 Subject: [PATCH 49/55] StreamExtensions, FileHelpers - Docs - Corrections - Otherwise word --- csharp/Platform.IO/FileHelpers.cs | 16 ++++++++-------- csharp/Platform.IO/StreamExtensions.cs | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index b777fab..1482ed2 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -65,7 +65,7 @@ public static T[] ReadAll(string path) /// Путь к файлу, из которого нужно прочитать значение структуры типа . /// /// - /// The structure value if read from the file at the is successful, otherwise the default structure value. + /// The structure value if read from the file at the is successful; otherwise the default structure value. /// Значение структуры типа если чтение из файла находящегося в прошло успешно, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -77,7 +77,7 @@ public static T ReadFirstOrDefault(string path) } /// - /// Returns the opened for reading from the file at the if the file exists, not empty and its size is a multiple of the structure size, otherwise . + /// Returns the opened for reading from the file at the if the file exists, not empty and its size is a multiple of the structure size; otherwise . /// Возвращает открытый для чтения из файла находящегося в , если файл существует, не пуст и его размер кратен размеру структуры типа , а иначе . /// /// @@ -89,7 +89,7 @@ public static T ReadFirstOrDefault(string path) /// Путь к проверяемому файлу. /// /// - /// A opened for reading in the case of successful check, otherwise . + /// A opened for reading in the case of successful check; otherwise . /// открытый для чтения в случае успешной проверки, а иначе . /// /// @@ -100,7 +100,7 @@ public static T ReadFirstOrDefault(string path) private static FileStream GetValidFileStreamOrDefault(string path) where TStruct : struct => GetValidFileStreamOrDefault(path, Structure.Size); /// - /// Returns the opened for reading from the file at the if the file exists, not empty and its size is a multiple of the required , otherwise . + /// Returns the opened for reading from the file at the if the file exists, not empty and its size is a multiple of the required ; otherwise . /// Возвращает открытый для чтения из файла находящегося в , если файл существует, не пуст и его размер кратен , а иначе . /// /// @@ -112,7 +112,7 @@ public static T ReadFirstOrDefault(string path) /// Требуемый размер элементов, находящихся в файле находящегося в . /// /// - /// A opened for reading in the case of successful check, otherwise . + /// A opened for reading in the case of successful check; otherwise . /// открытый для чтения в случае успешной проверки, а иначе . /// /// @@ -147,7 +147,7 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi /// Путь к файлу с значениями структур типа . /// /// - /// The last structure value from the file at the in the case of successful read, otherwise the default structure value. + /// The last structure value from the file at the in the case of successful read; otherwise the default structure value. /// Значение структуры типа из файла находящегося в в случае успешного чтения, иначе значение по умолчанию структуры типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -206,7 +206,7 @@ public static void WriteFirst(string path, T value) public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); /// - /// Returns the size of file at the if file exists, otherwise 0. + /// Returns the size of file at the if file exists; otherwise 0. /// Возвращает размер файла находящегося в если тот существует, иначе 0. /// /// @@ -214,7 +214,7 @@ public static void WriteFirst(string path, T value) /// Путь к файлу, размер которого нужно получить. /// /// - /// Size of file at the if it exists, otherwise 0. + /// Size of file at the if it exists; otherwise 0. /// Размер файла если файл находящийся в существует, либо 0. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index ec550ca..738716a 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -49,7 +49,7 @@ public static void Write(this Stream stream, T value) /// Поток, содержащий значение структуры типа . /// /// - /// The structure value, if its bytes from the are read, otherwise the default structure value. + /// The structure value, if its bytes from the are read; otherwise the default structure value. /// Значение структуры типа , если её байты из потока были прочитаны, иначе значение структуры типа по умолчанию. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] From d9d543a9b4692da5cc0c043681c8ed33ace42243 Mon Sep 17 00:00:00 2001 From: FreePhoenix Date: Sat, 27 Mar 2021 17:59:54 +0600 Subject: [PATCH 50/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 44 +++++++++++++++---------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 1482ed2..0eb77a7 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -192,7 +192,7 @@ public static void WriteFirst(string path, T value) /// /// Opens or creates the file at the and returns its with append mode and write access. - /// Открывает или создает файл находящегося в и возвращает его с модом добавления в конец и доступом записи. + /// Открывает или создает файл находящегося в и возвращает его с режимом дополнения и доступом записи. /// /// /// The path to the file to open or create. @@ -200,7 +200,7 @@ public static void WriteFirst(string path, T value) /// /// /// The with append mode and write access. - /// с модом добавления в конец и доступом записи. + /// с режимом дополнения и доступом записи. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); @@ -222,7 +222,7 @@ public static void WriteFirst(string path, T value) /// /// Sets the for the file at the . - /// Устанавливает размер файлу находящегося в . + /// Устанавливает файлу находящемуся в . /// /// /// The path to the file to be resized. @@ -230,7 +230,7 @@ public static void WriteFirst(string path, T value) /// /// /// The size to assign to the file at the . - /// Размер который будет присвоен файлу находящегося в . + /// Размер который будет присвоен файлу находящемуся в . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void SetSize(string path, long size) @@ -243,46 +243,46 @@ public static void SetSize(string path, long size) } /// - /// Removes all files from the . - /// Удаляет все файлы из директории . + /// Removes all files from the directory at the path . + /// Удаляет все файлы из директории находящейся по пути . /// /// - /// The directory to be cleaned. - /// Директория для очистки. + /// The path to the directory to be cleaned. + /// Путь к директории для очистки. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory) => DeleteAll(directory, "*"); /// - /// Removes all files from the according to the . - /// Удаляет все файлы из директории в соотвествии с шаблоном поиска . + /// Removes all files from the directory at the path according to the . + /// Удаляет все файлы из директории находящейся по пути в соотвествии с шаблоном поиска . /// /// - /// The directory to be cleaned. - /// Директория для очистки. + /// The path to the directory to be cleaned. + /// Путь к директории для очистки. /// /// - /// Search pattern for files in the . - /// Шаблон поиска для файлов в директории . + /// Search pattern for files in the directory at the path . + /// Шаблон поиска для файлов в директории находящейся по пути . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); /// - /// Removes all files from the directory according to the and the . - /// Удаляет все файлы из директории в соотвествии с шаблоном поиска и настройкой поиска . + /// Removes all files from the directory at the path according to the and the . + /// Удаляет все файлы из директории находящейся по пути в соотвествии с шаблоном поиска и настройкой поиска . /// /// - /// The directory to be cleaned. - /// Директория для очистки. + /// The path to the directory to be cleaned. + /// Путь к директории для очистки. /// /// - /// Search pattern for files in the . - /// Шаблон поиска для файлов в директории . + /// Search pattern for files in the directory at the path . + /// Шаблон поиска для файлов в директории находящейся по пути . /// /// - /// Specifies whether to search only in the current , or also in subdirectories. - /// Указывает следует ли искать только в текущей директории , или также в субдиректориях. + /// Specifies whether to search only in the current the directory at the path , or also in subdirectories. + /// Указывает следует ли искать только в текущей директории находящейся по пути , или также в субдиректориях. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern, SearchOption searchOption) From bc4c8c2f37d71973d3455e2ca1f07e46997491fa Mon Sep 17 00:00:00 2001 From: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com> Date: Sat, 27 Mar 2021 21:09:50 +0600 Subject: [PATCH 51/55] =?UTF-8?q?FileHelpers=20-=20Docs=20-=20=D0=94=D0=BE?= =?UTF-8?q?=D1=81=D1=82=D1=83=D0=BF=D0=BE=D0=BC=20=D0=B7=D0=B0=D0=BF=D0=B8?= =?UTF-8?q?=D1=81=D0=B8=20->=20=D0=94=D0=BE=D1=81=D1=82=D1=83=D0=BF=D0=BE?= =?UTF-8?q?=D0=BC=20=D0=BD=D0=B0=20=D0=B7=D0=B0=D0=BF=D0=B8=D1=81=D1=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- csharp/Platform.IO/FileHelpers.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 0eb77a7..31d0bbc 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -192,7 +192,7 @@ public static void WriteFirst(string path, T value) /// /// Opens or creates the file at the and returns its with append mode and write access. - /// Открывает или создает файл находящегося в и возвращает его с режимом дополнения и доступом записи. + /// Открывает или создает файл находящегося в и возвращает его с режимом дополнения и доступом на запись. /// /// /// The path to the file to open or create. @@ -200,7 +200,7 @@ public static void WriteFirst(string path, T value) /// /// /// The with append mode and write access. - /// с режимом дополнения и доступом записи. + /// с режимом дополнения и доступом на запись. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static FileStream Append(string path) => File.Open(path, FileMode.Append, FileAccess.Write); From 54b5000bbe17c47f371f260693ec79e3a544adbb Mon Sep 17 00:00:00 2001 From: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com> Date: Sat, 27 Mar 2021 22:17:24 +0600 Subject: [PATCH 52/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 31d0bbc..3ae6f16 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -53,8 +53,8 @@ public static T[] ReadAll(string path) } /// - /// Reads and returns the structure value from the file at the . - /// Считывает и возвращает значение структуры типа из файла находящегося в . + /// Reads and returns the first structure value from the file at the . + /// Считывает и возвращает первое значение структуры типа из файла находящегося в . /// /// /// The structure type. @@ -255,34 +255,34 @@ public static void SetSize(string path, long size) /// /// Removes all files from the directory at the path according to the . - /// Удаляет все файлы из директории находящейся по пути в соотвествии с шаблоном поиска . + /// Удаляет все файлы из директории находящейся по пути в соотвествии с . /// /// /// The path to the directory to be cleaned. /// Путь к директории для очистки. /// /// - /// Search pattern for files in the directory at the path . - /// Шаблон поиска для файлов в директории находящейся по пути . + /// A search pattern for files to be deleted. + /// Шаблон поиска для удаляемых файлов. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); /// /// Removes all files from the directory at the path according to the and the . - /// Удаляет все файлы из директории находящейся по пути в соотвествии с шаблоном поиска и настройкой поиска . + /// Удаляет все файлы из директории находящейся по пути в соотвествии с и . /// /// /// The path to the directory to be cleaned. /// Путь к директории для очистки. /// /// - /// Search pattern for files in the directory at the path . - /// Шаблон поиска для файлов в директории находящейся по пути . + /// A search pattern for files to be deleted. + /// Шаблон поиска для удаляемых файлов. /// /// - /// Specifies whether to search only in the current the directory at the path , or also in subdirectories. - /// Указывает следует ли искать только в текущей директории находящейся по пути , или также в субдиректориях. + /// A value that determines whether to search only in the current the directory at the path , or also in all subdirectories. + /// Значение определяющее искать ли только в текущей директории находящейся по пути , или также во всех субдиректориях. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern, SearchOption searchOption) From 2589840fdcf25ff30de5d3ce296e2e5ba0b48014 Mon Sep 17 00:00:00 2001 From: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com> Date: Sat, 27 Mar 2021 22:53:04 +0600 Subject: [PATCH 53/55] FileHelpers - Docs - DeleteAll - Corrections --- csharp/Platform.IO/FileHelpers.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index 3ae6f16..bf5574c 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -262,8 +262,8 @@ public static void SetSize(string path, long size) /// Путь к директории для очистки. /// /// - /// A search pattern for files to be deleted. - /// Шаблон поиска для удаляемых файлов. + /// A search pattern for files to be deleted in the directory at the path . + /// Шаблон поиска для удаляемых файлов в директории находящейся по пути . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); @@ -277,8 +277,8 @@ public static void SetSize(string path, long size) /// Путь к директории для очистки. /// /// - /// A search pattern for files to be deleted. - /// Шаблон поиска для удаляемых файлов. + /// A search pattern for files to be deleted in the directory at the path . + /// Шаблон поиска для удаляемых файлов в директории находящейся по пути . /// /// /// A value that determines whether to search only in the current the directory at the path , or also in all subdirectories. From 5888daab47714288aac53cbd04d28aa6a428a638 Mon Sep 17 00:00:00 2001 From: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com> Date: Sun, 28 Mar 2021 11:25:51 +0600 Subject: [PATCH 54/55] FileHelpers - Docs - Corrections --- csharp/Platform.IO/FileHelpers.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/csharp/Platform.IO/FileHelpers.cs b/csharp/Platform.IO/FileHelpers.cs index bf5574c..26de4bc 100644 --- a/csharp/Platform.IO/FileHelpers.cs +++ b/csharp/Platform.IO/FileHelpers.cs @@ -147,7 +147,7 @@ private static FileStream GetValidFileStreamOrDefault(string path, int elementSi /// Путь к файлу с значениями структур типа . /// /// - /// The last structure value from the file at the in the case of successful read; otherwise the default structure value. + /// The structure value from the file at the in the case of successful read; otherwise the default structure value. /// Значение структуры типа из файла находящегося в в случае успешного чтения, иначе значение по умолчанию структуры типа . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -254,8 +254,8 @@ public static void SetSize(string path, long size) public static void DeleteAll(string directory) => DeleteAll(directory, "*"); /// - /// Removes all files from the directory at the path according to the . - /// Удаляет все файлы из директории находящейся по пути в соотвествии с . + /// Removes files from the directory at the path according to the . + /// Удаляет файлы из директории находящейся по пути в соотвествии с . /// /// /// The path to the directory to be cleaned. @@ -269,8 +269,8 @@ public static void SetSize(string path, long size) public static void DeleteAll(string directory, string searchPattern) => DeleteAll(directory, searchPattern, SearchOption.TopDirectoryOnly); /// - /// Removes all files from the directory at the path according to the and the . - /// Удаляет все файлы из директории находящейся по пути в соотвествии с и . + /// Removes files from the directory at the path according to the and the . + /// Удаляет файлы из директории находящейся по пути в соотвествии с и . /// /// /// The path to the directory to be cleaned. From 7a2c3c0052cc0749555b6d76c5fa74e30af43f50 Mon Sep 17 00:00:00 2001 From: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com> Date: Sun, 28 Mar 2021 21:07:35 +0600 Subject: [PATCH 55/55] Update StreamExtensions.cs --- csharp/Platform.IO/StreamExtensions.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csharp/Platform.IO/StreamExtensions.cs b/csharp/Platform.IO/StreamExtensions.cs index 738716a..c84f700 100644 --- a/csharp/Platform.IO/StreamExtensions.cs +++ b/csharp/Platform.IO/StreamExtensions.cs @@ -62,7 +62,7 @@ public static T ReadOrDefault(this Stream stream) } /// - /// Reads and returns the structure values array from the . + /// Reads and returns all structure values array from the . /// Прочитывает и возвращает массив всех значений структур типа из потока . /// ///