ProtoPersister 0.1.0

.NET Standard 2.0

dotnet add package ProtoPersister --version 0.1.0

NuGet\Install-Package ProtoPersister -Version 0.1.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="ProtoPersister" Version="0.1.0" />

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

<PackageVersion Include="ProtoPersister" Version="0.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="ProtoPersister" />
                    

                            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 ProtoPersister --version 0.1.0

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

#r "nuget: ProtoPersister, 0.1.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 ProtoPersister@0.1.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=ProtoPersister&version=0.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=ProtoPersister&version=0.1.0
                    

                            Install as a Cake Tool

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

ProtoPersister

Persistence framework build on top of protobuf-net

Basic usage

Create your class

    public class MyDataClass
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public DateTime Anniversary { get; set; }
    }

Setup ProtoPersister, attach to your data class and save

    var persister = new Persister<MyDataClass>(
	                // the file extension does not matter, you can came up with your own one
                    new PersisterSettings("C:\\myDataFile.proto")
                    {
                        MaxHistorySteps = 100,
	                      // this will allow for undo/redo without notifying ProtoPersister explicitly about changes
                        TrackChanges = true,
                        AutoSave = new AutoSaveSettings()
                        {
                            AutoSaveFilePath = "C:\\myDataAutoSaveFile.proto",
                            Enabled = true,
                            SaveEvery = TimeSpan.FromMinutes(5)
                        }
                    }
                );

    var myDataClass = new MyDataClass() { Name = "Jack", Age = 20, Anniversary = DateTime.Today };
    persister.Attach(myDataClass);
    
    // save data
    persister.Save();

Undo/redo

    myDataClass.Age = 10;

    persister.Undo(); // -> now myDataClass = 20 
    persister.Redo() // -> now myDataClass = 10

Using a manual tracking of changes (`TrackChanges = false`):

    // change your object
    persister.CommitCurrentState("1"); // adds a new version of your class into the history stack

Load your data from a file

    var persister = Persister<MyDataClass>.Load(new PersisterSettings("C:\\myDataFile.proto"), "C:\\myDataFile.proto");
    var myDataClass = persister.TrackedObject;

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- protobuf-net (>= 2.3.7)

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
0.1.0	1,544	4/24/2018

First version