DTOMaker.Runtime.MemBlocks 0.71.8

There is a newer prerelease version of this package available.
See the version list below for details.

dotnet add package DTOMaker.Runtime.MemBlocks --version 0.71.8

NuGet\Install-Package DTOMaker.Runtime.MemBlocks -Version 0.71.8

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="DTOMaker.Runtime.MemBlocks" Version="0.71.8" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="DTOMaker.Runtime.MemBlocks" Version="0.71.8" />
                    

                            Directory.Packages.props

<PackageReference Include="DTOMaker.Runtime.MemBlocks" />
                    

                            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 DTOMaker.Runtime.MemBlocks --version 0.71.8

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: DTOMaker.Runtime.MemBlocks, 0.71.8"

#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 DTOMaker.Runtime.MemBlocks@0.71.8

#: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=DTOMaker.Runtime.MemBlocks&version=0.71.8
                    

                            Install as a Cake Addin

#tool nuget:?package=DTOMaker.Runtime.MemBlocks&version=0.71.8
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DTOMaker

NuGet Version NuGet Downloads GitHub License

Warning: This is pre-release software under active development. Breaking changes may occur.

A collection of model-driven compile-time source generators for quickly creating DTOs (Data Transport Objects) supporting the following serialization schemes:

JSON (NewtonSoft)
MessagePack
MemBlocks

and related types.

DTOMaker
- Workflow
Included Packages
Model features
- MemBlocks features
!Limitations
- Single compilation unit
Development

Workflow

---
title: Workflow
---
flowchart LR
    def(Define models e.g. IMyDTO.cs)
    ref1(Reference DTOMaker.Models.*)
    ref2(Reference DTOMaker.Runtime.*)
    ref3(Reference one or more source generators e.g. DTOMaker.MessagePack)
    bld(VS/Code/MSBuild)
    pkg(Assembly)
    ref1-->def
    def-->ref2
    def-->ref3
    ref2-->bld
    ref3-->bld
    bld-->pkg

Models are defined as C# interfaces with additional attributes. Here's a trivial example:

[Entity][Id(1)]
public interface IMyFirstDTO
{
    [Member(1)] string Name { get; set; }
}

If using the MessagePack source generator, the following implmentation will be generated (simplified):

[MessagePackObject]
public sealed class MyFirstDTO : EntityBase, IMyFirstDTO, IEquatable<MyFirstDTO>
{
    [Key(1)] string Name { get; set; }
}

Included Packages

This repo includes the following packages:

DTOMaker.Models

Attributes for defining simple data models as interfaces in C#.

DTOMaker.JsonNewtonSoft

A source generator that creates DTOs (Data Transport Objects) that are serializable to JSON using the Newtonsoft.Json package.

DTOMaker.MessagePack

A source generator that creates MessagePack DTOs (Data Transport Objects). See https://github.com/MessagePack-CSharp/MessagePack-CSharp.

DTOMaker.Models.MessagePack

Additional attributes used by the DTOMaker.MessagePack source generator, to manage MessagePack entity and member keys.

DTOMaker.MemBlocks

Generates DTOs whose internal data is a single memory block (Memory<byte>). Property getters and setters decode and encode values directly to the block with little-endian (default) or big-endian byte ordering.

DTOMaker.Models.MemBlocks

Additional attributes used by the DTOMaker.MemBlocks source generator, to manage entity and member memory layout.

DTOMaker.CSPoco

Generates basic POCOs (Plain Old C# Objects) that implement the model interfaces.