Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
90 lines
3.8 KiB
Groff
90 lines
3.8 KiB
Groff
.TH "serif::utils::dependencies::detail::NodeObservation< BeforeT, AfterT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::dependencies::detail::NodeObservation< BeforeT, AfterT > \- Each started hook owns one invocation state and finishes once, including on exceptional exit\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <observers\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBNodeObservation\fP (BeforeT &before, AfterT &after)"
|
|
.br
|
|
.RI "If before fails, construction fails and no matching completion is due\&. "
|
|
.ti -1c
|
|
.RI "\fBNodeObservation\fP (const \fBNodeObservation\fP &)=delete"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBNodeObservation\fP & \fBoperator=\fP (const \fBNodeObservation\fP &)=delete"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fB~NodeObservation\fP () noexcept"
|
|
.br
|
|
.RI "A throwing result transfer also interrupts the invocation; no catch/rethrow is needed\&. "
|
|
.ti -1c
|
|
.RI "template<typename ResultT> void \fBreturned\fP (const ResultT &result) noexcept"
|
|
.br
|
|
.RI "Distinguish an ordinary value from a computation's value-based rejection\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "AfterT & \fBm_after\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::invoke_result_t< BeforeT & > \fBm_state\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBm_exceptions\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBNodeOutcome\fP \fBm_outcome\fP {\fBNodeOutcome::exception\fP}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename BeforeT, typename AfterT>
|
|
.br
|
|
class serif::utils::dependencies::detail::NodeObservation< BeforeT, AfterT >"Each started hook owns one invocation state and finishes once, including on exceptional exit\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<typename BeforeT, typename AfterT> \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::NodeObservation (BeforeT & before, AfterT & after)\fR [inline]\fP"
|
|
|
|
.PP
|
|
If before fails, construction fails and no matching completion is due\&.
|
|
.SS "template<typename BeforeT, typename AfterT> \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::NodeObservation (const \fBNodeObservation\fP< BeforeT, AfterT > & )\fR [delete]\fP"
|
|
|
|
.SS "template<typename BeforeT, typename AfterT> \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::~\fBNodeObservation\fP ()\fR [inline]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
A throwing result transfer also interrupts the invocation; no catch/rethrow is needed\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename BeforeT, typename AfterT> \fBNodeObservation\fP & \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::operator= (const \fBNodeObservation\fP< BeforeT, AfterT > & )\fR [delete]\fP"
|
|
|
|
.SS "template<typename BeforeT, typename AfterT> template<typename ResultT> void \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::returned (const ResultT & result)\fR [inline]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Distinguish an ordinary value from a computation's value-based rejection\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename BeforeT, typename AfterT> AfterT& \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::m_after\fR [private]\fP"
|
|
|
|
.SS "template<typename BeforeT, typename AfterT> int \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::m_exceptions\fR [private]\fP"
|
|
|
|
.SS "template<typename BeforeT, typename AfterT> \fBNodeOutcome\fP \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::m_outcome {\fBNodeOutcome::exception\fP}\fR [private]\fP"
|
|
|
|
.SS "template<typename BeforeT, typename AfterT> std::invoke_result_t<BeforeT&> \fBserif::utils::dependencies::detail::NodeObservation\fP< BeforeT, AfterT >::m_state\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|