Byrone.Xenia.Encoding 0.1.1

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package Byrone.Xenia.Encoding --version 0.1.1
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Byrone.Xenia.Encoding" />
                    


                            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 Byrone.Xenia.Encoding --version 0.1.1
                    


                    

                
#r "nuget: Byrone.Xenia.Encoding, 0.1.1"
#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 Byrone.Xenia.Encoding@0.1.1
#: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=Byrone.Xenia.Encoding&version=0.1.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Byrone.Xenia.Encoding&version=0.1.1
                    


                            Install as a Cake Tool

Xenia.Encoding

Helpers to find the preferred encoding from the request and encode data.

Usage

A request may send the Accept-Encoding header. The value of this header is a list of accepted encodings, each encoding with its own weight defining the preference of the browser. By installing Xenia.Encoding, you can easily handle finding the preferred encoding and using this encoding to encode your response. Please keep in mind that only the response body should be encoded, not the headers.

Here's an example on how to get the right encoding and encode the response data:

using Byrone.Xenia;
using Byrone.Xenia.Utilities;

static IResponse RequestHandler(in Request request) =>
	new Response();

private readonly struct Response : IResponse
{
	public void Send(Socket client, in Request request)
	{
		var body = "<html><body>Hello World</body></html>"u8;

		// Parse the `Accept-Encoding` header, if present
		if (request.TryGetEncoding(out var encoding)) 
		{
			// Create a temporary stream to write encoded data to
			var stream = new RentedMemoryStream(64);
	
			// Encode the data to the stream and return a span containing the encoded data 
			var compressed = BodyEncoding.TryEncode(stream, encoding, EncodingTests.Body);
	
			Debug.Assert(compressed);
	
			var response = StringBuilder.Format(
				stackalloc byte[128],
				$"""
	 			HTTP/1.1 200 OK
	 			Content-Encoding: {encoding}
	 			Content-Type: text/html
	 			Server: xenia-test-server
	
	
	 			""" 
			);
	
			client.Send(response);
			// Send the encoded data
			client.Send(System.MemoryExtensions.AsSpan(stream.GetBuffer(), 0, (int)stream.Position));
	
			// Don't forget to dispose and release the stream's resources!
			stream.Dispose();
		}
		else
		{
			// Handle fallback...    
		}
	}
}
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

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.1 182 10/29/2024