This repository contains three projects which are individually very small. They were originally bundled as a single library package but as of April 2020, they have been separated into three distinct NuGet packages.
In addition, with version 7.0.0, a large amount of obsolete & redundant functionality has either been withdrawn or moved to other repositories.
The enums package provides extension methods for enum objects, in the classes EnumDefinitionExtensions and
EnumFlagsExtensions - both in the CSF namespace. The definition extensions are shortcuts to detect and assert
whether or not an object is a defined enum value (useful for parameter-checking). The flags extensions are used for
asserting that a given enum type is a [Flags]-based enum, and also a method for getting all of the current flags
values which are contained within a specified value.
The GUIDs package provides two extension methods (in the CSF namespace) to convert a Guid to/from
an RFC-4122 UUID byte array. The dotnet Guid implementation does not quite conform to this specification;
these extension methods may be used to get a conforming byte array (by re-ordering the bytes based on the
endianness of the computer).
Additionally, it provides an interface that defines a strategy by which Guid instances may be created. As well
as a 'normal' implementation, there is also a GuidCombCreator class available, which creates semi-sequential
instances, using the 'COMB' algorithm, documented in detail on this page of the linked article (albeit a SQL implementation).
One of the configuration parameters for a GUID COMB is the number of bytes which should be derived from the timestamp,
versus the number of bytes which should be random. A Guid is 16-bytes long and the timestamp-based component in a
COMB may be anything between 3 and 6 bytes inclusive. The default is 4 bytes from the timestamp. Any bytes which
are not derived from the timestamp are left unaltered from the underlying Guid-generation process; typically this
means that they are random.
The timestamp bytes are based upon the most significant bytes of the DateTime.Ticks property. This allows us to
calculate how often the timestamp-based part of the COMB will 'roll over' to a new value, for the various permitted
numbers of timestamp-based bytes:
- 3 bytes: Roughly every 27 ¾ hours
- 4 bytes: Roughly every 7 minutes (this is the default setting)
- 5 bytes: Roughly every 1.7 seconds
- 6 bytes: Roughly every 0.0066 (or 1/150th) of a second
The I/O package provides three extension methods (in the CSF namespace) relating to instances of FileSystemInfo,
to perform common actions. It also provides a builder object - FilenameExtensionBuilder - which may be used to
manipulate a filename, altering its filename extensions.
All source files within this project are released as open source software, under the terms of the MIT license.
This software is distributed in the hope that it will be useful, but please remember that:
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.