👁 Image
GenHTTP.Modules.IO 10.5.3

GenHTTP.Modules.IO

Provides I/O related functionality to be used within a GenHTTP application.

Resources

Access to resources such as files are abstracted in GenHTTP via IResourceTree and IResource. The I/O module adds common implementations to load resources from strings, files or an assembly. It also adds useful features such as virtual resource trees or change tracking for resources.

See the documentation for more details.

Content Implementations

Besides the resource implementations, the module adds some IResponseContent implementations that can be used to directly set the content when building a response.

See the documentation for more details.

Providers

The following handlers and concerns are provided by this module.

Handlers / Concerns

Those entry points allow to quickly create concerns and handlers without the need of implementing interfaces and of providing builders.

For documentation, see the concern and handler pages.

Content

Provides a single resource to a requesting client. In contrast to downloads, the response is expected to be consumed by the client without actually downloading it to a local file. The Content-Type is computed from the given resource. For named resources, the logic will try to guess the content type from the file extension.

using GenHTTP.Engine.Internal;

using GenHTTP.Modules.IO;
using GenHTTP.Modules.Layouting;
using GenHTTP.Modules.Practices;

var content = Content.From(Resource.FromString("Hello World!"));

var app = Layout.Create()
 .Add("hello", content);

await Host.Create()
 .Handler(app)
 .Defaults()
 .Console()
 .RunAsync();

The module also provides extensions

Downloads

Allows clients to download a single resource and to specify the name as it should be presented to the user. The logic tries to automatically determine the Content-Type of the resource.

using GenHTTP.Api.Protocol;

using GenHTTP.Engine.Internal;

using GenHTTP.Modules.IO;
using GenHTTP.Modules.Layouting;
using GenHTTP.Modules.Practices;

var file = Resource.FromFile("./my.pdf");

var download = Download.From(file)
 .FileName("invoice-user-1234.pdf") // optional, would be "my.pdf" otherwise
 .Type(ContentType.ApplicationPdf); // optional, automatically detected here

var app = Layout.Create()
 .Add("get-invoice", download);

await Host.Create()
 .Handler(app)
 .Defaults()
 .Console()
 .RunAsync();

Range Support

This concern allows clients to request only a specific part of the data provided by the inner handler. For this to work, the inner handler needs to set a Content-Length on the response. Chunked responses are not supported. Requires the HTTP method to be GET or HEAD.

The concern will set a Accept-Ranges: bytes header to signal range support to the client.

The client can then request a specific byte range using the Range header, e.g. Range: 100- to skip the first 100 bytes of the response.

While this concern can safely be applied to the root handler, it is recommended to apply it only to the handlers where the functionality is needed, as there is some runtime overhead for each request.

using GenHTTP.Engine.Internal;

using GenHTTP.Modules.IO;
using GenHTTP.Modules.Layouting;
using GenHTTP.Modules.Practices;

var download = Download.From(Resource.FromFile("my-large.bin"))
 .AddRangeSupport();

var app = Layout.Create()
 .Add("file", download);

await Host.Create()
 .Handler(app)
 .Defaults()
 .Console()
 .RunAsync();