Webserv
Loading...
Searching...
No Matches
http::upload::UploadValidationResult Struct Reference

Represents the result of a validation or parsing operation. More...

#include <FileUploadValidator.hpp>

Static Public Member Functions

static UploadValidationResult ok (const std::string &file)
 Creates a successful validation result with a filename.
static UploadValidationResult ok ()
 Creates a successful validation result with an empty filename.
static UploadValidationResult fail (HttpStatus s, const std::string &msg)
 Creates a failed validation result.

Public Attributes

bool result
 True if validation succeeded.
std::string filename
 Parsed or validated filename (empty if failed).
HttpStatus status
 HTTP status code associated with the result.
std::string message
 Detailed error message if validation failed.

Detailed Description

Represents the result of a validation or parsing operation.

This structure is used across upload-related utility functions to provide both success and failure states in a consistent way.

Fields:

  • result — true if validation succeeded, false otherwise.
  • filename — extracted or validated filename in case of success.
  • status — corresponding HTTP status code (e.g., 400, 403, 413, etc.).
  • message — human-readable explanation in case of failure.

Factory methods:

  • ok(filename) — creates a successful result with HTTP 200 (OK) and the provided filename.
  • fail(status, message) — creates a failed result with a specific error code and message.

Member Function Documentation

◆ fail()

UploadValidationResult http::upload::UploadValidationResult::fail ( HttpStatus s,
const std::string & msg )
static

Creates a failed validation result.

◆ ok() [1/2]

UploadValidationResult http::upload::UploadValidationResult::ok ( )
static

Creates a successful validation result with an empty filename.

◆ ok() [2/2]

UploadValidationResult http::upload::UploadValidationResult::ok ( const std::string & file)
static

Creates a successful validation result with a filename.

Member Data Documentation

◆ filename

std::string http::upload::UploadValidationResult::filename

Parsed or validated filename (empty if failed).

◆ message

std::string http::upload::UploadValidationResult::message

Detailed error message if validation failed.

◆ result

bool http::upload::UploadValidationResult::result

True if validation succeeded.

◆ status

HttpStatus http::upload::UploadValidationResult::status

HTTP status code associated with the result.


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