Share via

DefaultFilesMiddleware Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.StaticFiles
Assembly:
Microsoft.AspNetCore.StaticFiles.dll
Package:
Microsoft.AspNetCore.StaticFiles v1.0.0
Package:
Microsoft.AspNetCore.StaticFiles v1.1.0
Package:
Microsoft.AspNetCore.StaticFiles v2.0.0
Package:
Microsoft.AspNetCore.StaticFiles v2.1.0
Package:
Microsoft.AspNetCore.StaticFiles v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0
Source:
DefaultFilesMiddleware.cs
Source:
DefaultFilesMiddleware.cs
Source:
DefaultFilesMiddleware.cs

This examines a directory path and determines if there is a default file present. If so the file name is appended to the path and execution continues. Note we don't just serve the file because it may require interpretation.

public ref class DefaultFilesMiddleware
public class DefaultFilesMiddleware
type DefaultFilesMiddleware = class
Public Class DefaultFilesMiddleware
Inheritance
Object
DefaultFilesMiddleware

Constructors

DefaultFilesMiddleware(RequestDelegate, IHostingEnvironment, IOptions<DefaultFilesOptions>)

Creates a new instance of the DefaultFilesMiddleware.
DefaultFilesMiddleware(RequestDelegate, IWebHostEnvironment, IOptions<DefaultFilesOptions>)

Creates a new instance of the DefaultFilesMiddleware.

Methods

Invoke(HttpContext)

This examines the request to see if it matches a configured directory, and if there are any files with the configured default names in that directory. If so this will append the corresponding file name to the request path for a later middleware to handle.

Applies to