HttpResponse

This class is used to build a response which will be sent to the client.

As already said in the guide, a Response can be returned by a Controller method and it will be sent async to the client.

This class exposes a fluent API, which means you can chain all its methods :

Response.Status(200)
        .AddHeader("key", "value")
        .Text("Hello World");

Constructor

/// <summary>
/// Constructor
/// </summary>
/// <param name="session"></param>
/// <param name="bufferPool"></param>
public HttpResponse(HttpSession session, ArrayPool<byte> bufferPool)

DANGER

Never instanciate your own HttpResponse, this is already done by HttpSession is a proper way (GC friendly).

Status

/// <summary>
/// Set Status
/// </summary>
/// <param name="statusCode">default: 200</param>
/// <param name="statusText">default: "OK"</param>
/// <returns></returns>
public HttpResponse Status(int statusCode, string? statusText = null)

ContentType

/// <summary>
/// Set ContentType
/// </summary>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse ContentType(string contentType)

ContextTypeFromExtension

/// <summary>
/// Set ContentType from a file extension (e.g: ".html")
/// </summary>
/// <param name="extension"></param>
/// <returns></returns>
public HttpResponse ContextTypeFromExtension(string extension)

AddHeader

/// <summary>
/// Add Header
/// </summary>
/// <param name="name"></param>
/// <param name="value"></param>
/// <returns></returns>
public HttpResponse AddHeader(string name, string value)

Body

/// <summary>
/// Set Body from byte[] (borrowed stable, array-backed)
/// </summary>
/// <param name="body"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse Body(byte[] body, string? contentType = "application/octet-stream")

/// <summary>
/// Set Body from ArraySegment (borrowed stable, array-backed, supports offset/len)
/// </summary>
/// <param name="body"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse Body(ArraySegment<byte> body, string? contentType = "application/octet-stream")

/// <summary>
/// Set Body from ReadOnlyMemory (borrowed stable if no owner provided)
/// If array-backed => store as Segment immediately
/// If not array-backed => store as Memory
/// </summary>
/// <param name="body"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse Body(ReadOnlyMemory<byte> body, string? contentType = "application/octet-stream")

/// <summary>
/// Set Body with explicit owner (zero-copy + safe lifetime)
/// </summary>
/// <param name="body"></param>
/// <param name="owner"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse Body(ReadOnlyMemory<byte> body, IDisposable owner, string? contentType = "application/octet-stream")

Text

/// <summary>
/// Set UTF-8 text Body (owned pooled buffer)
/// </summary>
/// <param name="body"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse Text(string body, string contentType = "text/plain; charset=utf-8")

Json

/// <summary>
/// Set JSON Body serialized into pooled buffer
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="value"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse Json<T>(T value, string contentType = "application/json; charset=utf-8")

File

/// <summary>
/// Set File Body
/// </summary>
/// <param name="path"></param>
/// <param name="contentType"></param>
/// <returns></returns>
public HttpResponse File(string path, string? contentType = null)

/// <summary>
/// Set File Body from FileInfo (avoids re-stat / allows caller to pre-validate)
/// </summary>
/// <param name="fi"></param>
/// <param name="contentType"></param>
/// <returns></returns>
/// <exception cref="ArgumentNullException"></exception>
public HttpResponse File(FileInfo fi, string? contentType = null)

Compression

/// <summary>
/// Configure compression policy for this response
/// </summary>
/// <param name="mode"></param>
/// <param name="minSize"></param>
/// <param name="level"></param>
/// <returns></returns>
public HttpResponse Compression(ResponseCompressionMode mode, int? minSize = null, CompressionLevel? level = null)

NoCompression

/// <summary>
/// Convenience: disable compression for this response
/// </summary>
public HttpResponse NoCompression()

SendAsync

/// <summary>
/// Send the response now
/// </summary>
/// <returns></returns>
public async ValueTask SendAsync()

This is the proper way of sending data a client in you want to do it on your own.

DefaultContentType

/// <summary>
/// Get Content Type from a file extension (e.g: ".html")
/// </summary>
/// <param name="extension"></param>
/// <returns></returns>
public static string DefaultContentType(string extension)

DefaultStatusText

/// <summary>
/// Get the Default Status Text for a status code
/// </summary>
/// <param name="code"></param>
/// <returns></returns>
public static string DefaultStatusText(int code)

Cookies

/// <summary>
/// Set a Cookie
/// So tell client to create a cookie on its side
/// </summary>
/// <param name="name"></param>
/// <param name="value"></param>
/// <param name="options"></param>
/// <returns></returns>
public HttpResponse SetCookie(string name, string value, in CookieOptions options = default)

/// <summary>
/// Delete a Cookie
/// So tell client to delete the cookie on its side
/// </summary>
/// <param name="name"></param>
/// <param name="path"></param>
/// <param name="domain"></param>
/// <returns></returns>
public HttpResponse DeleteCookie(string name, string? path = "/", string? domain = null)

/// <summary>
/// Clear all Cookies
/// clear cookies here, so no cookie will be written in the response
/// </summary>
/// <returns></returns>
public HttpResponse ClearCookies()

Aliases

The following methods provide a convenient way for the common response.

/// <summary>
/// Not Found 404
/// </summary>
/// <param name="body"></param>
/// <returns></returns>
public HttpResponse NotFound(string? body = null)

/// <summary>
/// Internal Server Error 500
/// </summary>
/// <param name="body"></param>
/// <returns></returns>
public HttpResponse InternalServerError(string? body = null)

/// <summary>
/// Redirect 302
/// </summary>
/// <param name="url"></param>
/// <returns></returns>
public HttpResponse Redirect(string url)

/// <summary>
/// Unauthorized 401
/// </summary>
/// <param name="body"></param>
/// <returns></returns>
public HttpResponse Unauthorized(string? body = null)

/// <summary>
/// Forbidden 403
/// </summary>
/// <param name="body"></param>
/// <returns></returns>
public HttpResponse Forbidden(string? body = null)

/// <summary>
/// Access 401/403
/// </summary>
/// <param name="isWebuser"></param>
/// <returns></returns>
public HttpResponse Access(bool isWebuser = false)