nsbaci 1.0
Loading...
Searching...
No Matches
FileResult Struct Reference

Base result type for file operations. More...

#include <fileService.h>

Inheritance diagram for FileResult:
Collaboration diagram for FileResult:

Public Member Functions

 FileResult ()
 Default constructor creates a successful result.
 FileResult (std::vector< nsbaci::Error > errs)
 Constructs a result from a vector of errors.
 FileResult (nsbaci::Error error)
 Constructs a failed result from a single error.
 FileResult (FileResult &&) noexcept=default
FileResultoperator= (FileResult &&) noexcept=default
 FileResult (const FileResult &)=default
FileResultoperator= (const FileResult &)=default
Public Member Functions inherited from nsbaci::BaseResult
 BaseResult ()
 Default constructor creates a successful result.
 BaseResult (std::vector< nsbaci::Error > errs)
 Constructs a result from a vector of errors.
 BaseResult (nsbaci::Error error)
 Constructs a failed result from a single error.
 BaseResult (BaseResult &&) noexcept=default
BaseResultoperator= (BaseResult &&) noexcept=default
 BaseResult (const BaseResult &)=default
BaseResultoperator= (const BaseResult &)=default

Additional Inherited Members

Public Attributes inherited from nsbaci::BaseResult
bool ok
 True if the operation succeeded.
std::vector< nsbaci::Errorerrors
 Errors encountered (empty if ok is true).

Detailed Description

Base result type for file operations.

Extends BaseResult with file-specific semantics. All file operation results inherit from this type.

Invariant
If ok is false, errors vector contains at least one error.

Constructor & Destructor Documentation

◆ FileResult() [1/2]

FileResult::FileResult ( std::vector< nsbaci::Error > errs)
inlineexplicit

Constructs a result from a vector of errors.

Parameters
errsVector of errors encountered during the operation.
Here is the call graph for this function:

◆ FileResult() [2/2]

FileResult::FileResult ( nsbaci::Error error)
inlineexplicit

Constructs a failed result from a single error.

Parameters
errorThe error that caused the operation to fail.
Here is the call graph for this function:

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