malloy::http::generator Class Reference

#include <generator.hpp>

Public Member Functions
	generator ()=default
	generator (const generator &other)=delete
	generator (generator &&other)=delete
virtual	~generator ()=default
generator &	operator= (const generator &rhs)=delete
generator &	operator= (generator &&rhs)=delete

Static Public Member Functions
static response	ok ()
static response	redirect (status code, std::string_view location)
static response	bad_request (std::string_view reason)
static response	not_found (std::string_view resource)
static response	server_error (std::string_view what)
template<malloy::http::concepts::body Body>
static file_response	file (const request< Body > &req, const std::filesystem::path &storage_base_path)
static file_response	file (const std::filesystem::path &storage_path, std::string_view rel_path)

Detailed Description

A generator for HTTP responses.

Constructor & Destructor Documentation

generator()

malloy::http::generator::generator ( )

default

Default constructor.

~generator()

virtual malloy::http::generator::~generator ( )

virtualdefault

Destructor

Member Function Documentation

bad_request()

response generator::bad_request ( std::string_view  reason )

static

Construct a 400 error.

Parameters

reason

An explanation of why this request is considered a bad one.

Returns

The response.

file() [1/2]

template<malloy::http::concepts::body Body>

static file_response malloy::http::generator::file ( const request< Body > &  req, const std::filesystem::path &  storage_base_path  )

inlinestatic

Construct a file response.

Parameters

req	The request to be responded to.
storage_base_path	The base path to the local filesystem.

Returns

The response.

Here is the call graph for this function:

file() [2/2]

generator::file_response generator::file ( const std::filesystem::path &  storage_path, std::string_view  rel_path  )

static

Construct a file response.

Parameters

storage_path	The base path to the local filesystem.
rel_path	The file being requested relative to the storage_path.

Returns

The response.

Here is the call graph for this function:

not_found()

response generator::not_found ( std::string_view  resource )

static

Construct a 404 error.

Parameters

resource

The resource that was being requested.

Returns

The response.

ok()

response generator::ok ( )

static

Construct a 200 response.

redirect()

response generator::redirect ( status  code, std::string_view  location  )

static

Construct a 3xx response.

Parameters

code	The HTTP status code. Must be a 3xx status code.
location	The location to redirect to.

Returns

The response.

Here is the call graph for this function:

server_error()

response generator::server_error ( std::string_view  what )

static

Construct a 500 error.

Parameters

what	An optional error message.

Returns

The response.

---

The documentation for this class was generated from the following files:

• lib/malloy/core/http/generator.hpp
• lib/malloy/core/http/generator.cpp