Files

83 lines
2.2 KiB
Groff
Raw Permalink Normal View History

.TH "src/include/serif/utils/dependencies/resource.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/resource.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <functional>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include <utility>\fP
.br
\fR#include 'serif/utils/dependencies/snapshot\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::utils::dependencies::detail::OwnedValue< T >\fP"
.br
.ti -1c
.RI "struct \fBserif::utils::dependencies::detail::BorrowedValue< T >\fP"
.br
.ti -1c
.RI "class \fBserif::utils::dependencies::Resource< KeyT, StorageT, PolicyT >\fP"
.br
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::dependencies\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::dependencies::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::utils::dependencies::IsResource\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename KeyT, typename ValueT, typename PolicyT = ValueSnapshot> auto \fBserif::utils::dependencies::own\fP (ValueT &&value, PolicyT policy={})"
.br
.RI "Store a value in the context; rvalues transfer ownership and lvalues are copied\&. "
.ti -1c
.RI "template<typename KeyT, typename ValueT, typename PolicyT = ValueSnapshot> auto \fBserif::utils::dependencies::borrow\fP (ValueT &value, PolicyT policy={})"
.br
.RI "Bind an existing object whose lifetime must cover every use of the context\&. "
.ti -1c
.RI "template<typename KeyT, typename ValueT, typename PolicyT = ValueSnapshot> auto \fBserif::utils::dependencies::borrow\fP (const ValueT &&, PolicyT={})=delete"
.br
.RI "Borrowed storage must never refer to a temporary, including a const temporary\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBserif::utils::dependencies::is_resource_v\fP = false"
.br
.ti -1c
.RI "template<typename KeyT, typename StorageT, typename PolicyT> constexpr bool \fBserif::utils::dependencies::is_resource_v< Resource< KeyT, StorageT, PolicyT > >\fP = true"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.