FlatSharp.Runtime 7.5.0

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

dotnet add package FlatSharp.Runtime --version 7.5.0

NuGet\Install-Package FlatSharp.Runtime -Version 7.5.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="FlatSharp.Runtime" Version="7.5.0" />

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

paket add FlatSharp.Runtime --version 7.5.0

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

#r "nuget: FlatSharp.Runtime, 7.5.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.

// Install FlatSharp.Runtime as a Cake Addin
#addin nuget:?package=FlatSharp.Runtime&version=7.5.0

// Install FlatSharp.Runtime as a Cake Tool
#tool nuget:?package=FlatSharp.Runtime&version=7.5.0

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

Welcome to FlatSharp!

Thanks for using FlatSharp! FlatSharp is a C# FlatBuffers implementation designed to be secure, fast, and easy to use.

Quick Resources

Issues, Contributions, and Feedback

FlatSharp is open source. Find it on GitHub! Issues, contributions, and other feedback are always welcome. Don't be a stranger! If you have feedback to share, please consider filling out the form here!

Sponsorship

FlatSharp is free and always will be. However, the project does take a significant amount of time to maintain. If you or your organization find the project useful, please consider a Github sponsorship. Any amount is appreciated!

Quick Start

1. Reference FlatSharp

Reference both FlatSharp.Runtime and FlatSharp.Compiler. Use the same version for them both.

2. Define a Schema

// all FlatSharp FBS attributes start with the 'fs_' prefix.
attribute "fs_serializer";

namespace MyNamespace;

enum Color : ubyte { Red = 1, Green, Blue }

table Person (fs_serializer) {
    Id:int;
    Name:string;
    Parent:Person (deprecated);
    Children:[Person];
    FavoriteColor:Color = Blue;
    Position:Location;
}

struct Location {
    Latitude:float;
    Longitude:float;
}

3. Update Your csproj

   <ItemGroup>
     <FlatSharpSchema Include="YourSchema.fbs" />
   </ItemGroup>

4. Serialize Your Data

Person person = new Person(...);
int maxBytesNeeded = Person.Serializer.GetMaxSize(person);
byte[] buffer = new byte[maxBytesNeeded];
int bytesWritten = Person.Serializer.Serialize(buffer, person);

5. Parse Your Data

Person p = Person.Serializer.Parse(data);

License

FlatSharp is licensed under Apache 2.0. Have fun 😃

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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 is compatible. 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 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.
.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 is compatible.
.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
- System.Memory (>= 4.5.5)
.NETStandard 2.1
- System.Memory (>= 4.5.5)
net6.0
- System.Memory (>= 4.5.5)
net7.0
- System.Memory (>= 4.5.5)
net8.0
- System.Memory (>= 4.5.5)

NuGet packages (4)

Showing the top 4 NuGet packages that depend on FlatSharp.Runtime:

Package	Downloads
FlatSharp FlatSharp is an idiomatic C# implementation of the FlatBuffer serialization format. Use attributes to declare your data contracts!	138.0K
FlatSharp.Unsafe Performance-optimized unsafe extensions to the FlatSharp package.	22.7K
LeagueToolkit Library for Parsing and Editing file formats from League of Legends	16.2K
OpenShock.Serialization.Flatbuffers Contains flatbuffers source files with flatbuffers compiler setup to generate useable flatbuffer bindings	1.3K

GitHub repositories (7)

Showing the top 5 popular GitHub repositories that depend on FlatSharp.Runtime:

Repository	Stars
Nexus-Mods/NexusMods.App Home of the development of the Nexus Mods App	1.1K
jamescourtney/FlatSharp Fast, idiomatic C# implementation of Flatbuffers	512
kwsch/pkNX Pokémon (Nintendo Switch) ROM Editor & Randomizer	360
Manu098vm/Tera-Finder This is a PKHeX.Core based program that allows to view, edit and calculate Raids and Mass Outbreaks for Pokémon Scarlet & Violet.	175
LegoFigure11/RaidCrawler Raid Viewer for Pokémon Scarlet and Violet	169

Version	Downloads	Last updated
7.8.0	224	11/14/2024
7.7.0	21,745	5/31/2024
7.6.0	152,920	3/14/2024
7.5.1	933	2/25/2024
7.5.0	282	2/23/2024
7.4.0	44,492	12/2/2023
7.3.0	9,713	9/12/2023
7.2.3	15,815	8/11/2023
7.2.1	847	8/4/2023
7.2.0	257	8/3/2023
7.1.1	9,673	3/17/2023
7.1.0	4,587	1/31/2023
7.0.2	18,217	11/25/2022
7.0.1	1,374	11/18/2022
7.0.0	476	11/17/2022
6.3.5	8,448	11/4/2022
6.3.3	4,995	10/1/2022
6.3.2	1,539	9/21/2022
6.3.1	31,371	4/26/2022
6.3.0	797	4/24/2022
6.2.1	1,972	3/15/2022
6.2.0	2,370	2/17/2022
6.1.1	785	2/7/2022
6.1.0	790	2/4/2022
6.0.5	2,252	1/6/2022
6.0.4	11,470	12/16/2021
6.0.3	507	12/14/2021
6.0.2	1,287	12/8/2021
6.0.1	813	12/5/2021
6.0.0	17,280	9/18/2021
6.0.0-beta3	296	9/16/2021
6.0.0-beta2	288	9/13/2021
6.0.0-beta1	319	9/13/2021
5.7.1	3,911	8/26/2021
5.7.0	8,097	8/24/2021
5.6.0	802	7/27/2021
5.5.0	823	7/1/2021
5.4.1	696	6/22/2021
5.4.0	887	6/9/2021
5.3.1	807	5/30/2021
5.3.0	717	5/23/2021
5.2.1	1,442	5/7/2021
5.2.0	1,591	4/12/2021
5.1.0	1,652	3/18/2021
5.0.1	786	3/14/2021
5.0.0	1,933	3/10/2021
4.2.4	21,312	2/22/2021
4.2.3	1,650	2/16/2021
4.2.2	752	2/14/2021
4.2.1	704	2/14/2021
4.2.0	662	2/14/2021
4.1.0	2,754	10/17/2020
4.0.2	1,052	10/11/2020
4.0.1	837	10/8/2020
4.0.0	867	10/7/2020
3.3.1	8,763	9/7/2020
3.3.0	914	8/20/2020
3.2.0	1,160	7/30/2020
3.1.1	860	7/28/2020
3.1.0	934	7/27/2020
3.0.0	2,043	3/30/2020
2.1.0	4,066	2/9/2020
2.0.0	863	2/2/2020
1.2.0	953	1/30/2020

Release notes at https://github.com/jamescourtney/FlatSharp/releases