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)
63 lines
4.0 KiB
TeX
63 lines
4.0 KiB
TeX
\doxysection{src/include/serif/utils/dependencies/resource.hpp File Reference}
|
|
\hypertarget{resource_8hpp}{}\label{resource_8hpp}\index{src/include/serif/utils/dependencies/resource.hpp@{src/include/serif/utils/dependencies/resource.hpp}}
|
|
{\ttfamily \#include $<$functional$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/snapshot.\+hpp"{}}\newline
|
|
Include dependency graph for resource.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{resource_8hpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
This graph shows which files directly or indirectly include this file\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{resource_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1detail_1_1_owned_value}{serif\+::utils\+::dependencies\+::detail\+::\+Owned\+Value$<$ T $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1detail_1_1_borrowed_value}{serif\+::utils\+::dependencies\+::detail\+::\+Borrowed\+Value$<$ T $>$}}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1utils_1_1dependencies_1_1_resource}{serif\+::utils\+::dependencies\+::\+Resource$<$ Key\+T, Storage\+T, Policy\+T $>$}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies}{serif\+::utils\+::dependencies}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_1_1detail}{serif\+::utils\+::dependencies\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1utils_1_1dependencies_1_1_is_resource}{serif\+::utils\+::dependencies\+::\+Is\+Resource}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename KeyT, typename ValueT, typename PolicyT = Value\+Snapshot$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a80612ee1a5c84ccd1b36e5aab14c17d5}{serif\+::utils\+::dependencies\+::own}} (ValueT \&\&value, PolicyT policy=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Store a value in the context; rvalues transfer ownership and lvalues are copied. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename KeyT, typename ValueT, typename PolicyT = Value\+Snapshot$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_abdacec2dea2bb64ecda1946529961565}{serif\+::utils\+::dependencies\+::borrow}} (ValueT \&value, PolicyT policy=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Bind an existing object whose lifetime must cover every use of the context. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename KeyT, typename ValueT, typename PolicyT = Value\+Snapshot$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a2b9af58b739c7c1217fad649158a1063}{serif\+::utils\+::dependencies\+::borrow}} (const ValueT \&\&, PolicyT=\{\})=delete
|
|
\begin{DoxyCompactList}\small\item\em Borrowed storage must never refer to a temporary, including a const temporary. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename T$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a97396efb03530235b2aa83115cf2f921}{serif\+::utils\+::dependencies\+::is\+\_\+resource\+\_\+v}} = false
|
|
\item
|
|
{\footnotesize template$<$typename KeyT, typename StorageT, typename PolicyT$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a6059315fec7209b8443d75ac7a680880}{serif\+::utils\+::dependencies\+::is\+\_\+resource\+\_\+v$<$ Resource$<$ Key\+T, Storage\+T, Policy\+T $>$ $>$}} = true
|
|
\end{DoxyCompactItemize}
|