Oakrey.Capsule.Metadata 1.0.0

dotnet add package Oakrey.Capsule.Metadata --version 1.0.0
                    
NuGet\Install-Package Oakrey.Capsule.Metadata -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Oakrey.Capsule.Metadata" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Oakrey.Capsule.Metadata" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Oakrey.Capsule.Metadata" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Oakrey.Capsule.Metadata --version 1.0.0
                    
#r "nuget: Oakrey.Capsule.Metadata, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Oakrey.Capsule.Metadata@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Oakrey.Capsule.Metadata&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Oakrey.Capsule.Metadata&version=1.0.0
                    
Install as a Cake Tool

Oakrey.Capsule.Metadata

Overview

The Capsule.Metadata library is a .NET 8-based framework designed for managing metadata in a structured and extensible manner. It provides a robust system for defining, serializing, and deserializing metadata records, making it ideal for applications requiring detailed data annotations, such as IoT, telemetry, and data logging.

Features

Metadata Management:

  • MetaCapsule for encapsulating multiple metadata records.
  • Support for up to 255 metadata records per capsule.

Data Types:

  • Support for various data types, including strings, booleans, integers, floats, and doubles.
  • Extensible DataType enumeration for defining custom data types.

Serialization and Deserialization:

  • Serialize metadata into binary format for efficient storage and transmission.
  • Deserialize binary payloads into metadata objects using MetaDataFactory.

Metadata Records:

  • Abstract MetaData<T> class for defining metadata with a key, value, and unit.
  • StringMetaData implementation for managing string-based metadata.

Units:

  • Unit enumeration for specifying units of measurement (e.g., seconds, dimensionless).

Extensibility:

  • Interface IMetaData for creating custom metadata types.
  • Factory pattern for adding support for new data types.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

  1. Open your project in Visual Studio.
  2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
  3. Search for Oakrey.Capsule.Metadata and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Capsule.Metadata

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Capsule.Metadata

Requirements

  • .NET 8 or higher

Project Information

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 187 4/22/2025