OryxEngine.Memory.Optionals 1.2.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package OryxEngine.Memory.Optionals --version 1.2.0
                    


                    

                
NuGet\Install-Package OryxEngine.Memory.Optionals -Version 1.2.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="OryxEngine.Memory.Optionals" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="OryxEngine.Memory.Optionals" Version="1.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="OryxEngine.Memory.Optionals" />
                    


                            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 OryxEngine.Memory.Optionals --version 1.2.0
                    


                    

                
#r "nuget: OryxEngine.Memory.Optionals, 1.2.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 OryxEngine.Memory.Optionals@1.2.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=OryxEngine.Memory.Optionals&version=1.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=OryxEngine.Memory.Optionals&version=1.2.0
                    


                            Install as a Cake Tool

OryxEngine.Memory.Optionals

A module from Oryx Engine used to write and read data from a byte buffer. Made in .NET 9.

How to use?

  • Clone Memory folder into wanted location
  • Create a new Reader/Writer and assign a buffer to it.
  • Use the IReader/IWriter functions to write data to or read data from the buffer.

Notes

  • This package works as a dropping replacement for OryxEngine.Memory with only a few changes
  • No longer throws exceptions and instead calls an Action that you pass into Writer/Reader when an error occurs
  • The base classes ReaderBig/ReaderLittle or WriterBig/WriterLittle return Option<T> instead of their respective T
  • Follows the same version as OryxEngine.Memory

Example

private static void Main(string[] args) {    
    //Initalize objects and buffer
    var buffer = new byte[0x10000];
    var writer = new Writer(EndianMode.Big, buffer /*, failureCallback */);
    var reader = new Reader(EndianMode.Big, buffer /*, failureCallback */);

    //Resets the position and expected length to a certain size
    //In a socket scenario set this to the length of the received data
    reader.Reset(sizeof(int) + sizeof(ushort));

    //Write some data and read it
    writer.Write(100);
    writer.Write(ushort.MaxValue);

    var intValue = reader.ReadInt32();
    var ushortValue = reader.ReadUInt16();

    //Reading out of bounds, this will call failureCallback!!!
    //Writing out of bounds will also call failureCallback!!!
    //var byteValue = reader.ReadByte();

    Console.WriteLine("Finished: {0}, {1}, {2}, {3}", intValue, ushortValue, reader.Position, reader.Buffer.Length);
}
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  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 (2)

Showing the top 2 NuGet packages that depend on OryxEngine.Memory.Optionals:

Package Downloads
OryxEngine.Networking

Networking library for OryxEngine
OryxEngine

A Game Engine made in C#

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.2.0 684 3/25/2025