everett::cola_detail::file_index_output< P, Ops, SpoolOps > Struct Template Reference

#include <cola_file_index.h>

Public Types
using	stream_type = object_stream< P, Ops >
using	spool_type = secondary_spool< SpoolOps >
using	main_sink = sort_profile_detail::file_bit_sink< P, Ops >
using	secondary_sink = sort_profile_detail::file_bit_sink< P, SpoolOps, spool_type >

Public Member Functions
	file_index_output (std::filesystem::path root, object_id id, object_attempt_id attempt, cola_file_dependencies dependencies, Ops &ops, SpoolOps &spool_ops)
bool	failed () const noexcept
bool	finished () const noexcept
object_write_paths const &	paths () const &noexcept
object_write_paths const &	paths () const &&=delete
std::uint64_t	spooled_bytes () const noexcept
void	append_known (unsigned route, bit_view key, std::uint64_t common)
template<class Native , class Main >
object_seal_receipt	finish (std::shared_ptr< Native const > native, std::shared_ptr< Main const > main, std::shared_ptr< Native const > secondary, index_metadata< P > metadata)

Private Member Functions
void	require_active () const

Static Private Member Functions
static cola_file_dependencies	checked (cola_file_dependencies deps)

Private Attributes
cola_file_dependencies	dependencies_
stream_type	stream_
spool_type	spool_
main_sink	main_
secondary_sink	secondary_
std::array< borrowed_file_state< P >, 2 >	profiles_
bool	failed_ = false

Member Typedef Documentation

main_sink

template<class P , class Ops , class SpoolOps >

using everett::cola_detail::file_index_output< P, Ops, SpoolOps >::main_sink = sort_profile_detail::file_bit_sink<P, Ops>

secondary_sink

template<class P , class Ops , class SpoolOps >

using everett::cola_detail::file_index_output< P, Ops, SpoolOps >::secondary_sink = sort_profile_detail::file_bit_sink<P, SpoolOps, spool_type>

spool_type

template<class P , class Ops , class SpoolOps >

using everett::cola_detail::file_index_output< P, Ops, SpoolOps >::spool_type = secondary_spool<SpoolOps>

stream_type

template<class P , class Ops , class SpoolOps >

using everett::cola_detail::file_index_output< P, Ops, SpoolOps >::stream_type = object_stream<P, Ops>

Constructor & Destructor Documentation

file_index_output()

template<class P , class Ops , class SpoolOps >

everett::cola_detail::file_index_output< P, Ops, SpoolOps >::file_index_output ( std::filesystem::path  root, object_id  id, object_attempt_id  attempt, cola_file_dependencies  dependencies, Ops &  ops, SpoolOps &  spool_ops  )

inline

Member Function Documentation

append_known()

template<class P , class Ops , class SpoolOps >

void everett::cola_detail::file_index_output< P, Ops, SpoolOps >::append_known ( unsigned  route, bit_view  key, std::uint64_t  common  )

inline

checked()

template<class P , class Ops , class SpoolOps >

static cola_file_dependencies everett::cola_detail::file_index_output< P, Ops, SpoolOps >::checked ( cola_file_dependencies  deps )

inlinestaticprivate

failed()

template<class P , class Ops , class SpoolOps >

bool everett::cola_detail::file_index_output< P, Ops, SpoolOps >::failed ( ) const

inlinenoexcept

finish()

template<class P , class Ops , class SpoolOps >

template<class Native , class Main >

object_seal_receipt everett::cola_detail::file_index_output< P, Ops, SpoolOps >::finish ( std::shared_ptr< Native const >  native, std::shared_ptr< Main const >  main, std::shared_ptr< Native const >  secondary, index_metadata< P >  metadata  )

inline

finished()

template<class P , class Ops , class SpoolOps >

bool everett::cola_detail::file_index_output< P, Ops, SpoolOps >::finished ( ) const

inlinenoexcept

paths() [1/2]

template<class P , class Ops , class SpoolOps >

object_write_paths const & everett::cola_detail::file_index_output< P, Ops, SpoolOps >::paths ( ) const &&

delete

paths() [2/2]

template<class P , class Ops , class SpoolOps >

object_write_paths const & everett::cola_detail::file_index_output< P, Ops, SpoolOps >::paths ( ) const &

inlinenoexcept

require_active()

template<class P , class Ops , class SpoolOps >

void everett::cola_detail::file_index_output< P, Ops, SpoolOps >::require_active ( ) const

inlineprivate

spooled_bytes()

template<class P , class Ops , class SpoolOps >

std::uint64_t everett::cola_detail::file_index_output< P, Ops, SpoolOps >::spooled_bytes ( ) const

inlinenoexcept

Member Data Documentation

dependencies_

template<class P , class Ops , class SpoolOps >

cola_file_dependencies everett::cola_detail::file_index_output< P, Ops, SpoolOps >::dependencies_

private

failed_

template<class P , class Ops , class SpoolOps >

bool everett::cola_detail::file_index_output< P, Ops, SpoolOps >::failed_ = false

private

main_

template<class P , class Ops , class SpoolOps >

main_sink everett::cola_detail::file_index_output< P, Ops, SpoolOps >::main_

private

profiles_

template<class P , class Ops , class SpoolOps >

std::array<borrowed_file_state<P>, 2> everett::cola_detail::file_index_output< P, Ops, SpoolOps >::profiles_

private

secondary_

template<class P , class Ops , class SpoolOps >

secondary_sink everett::cola_detail::file_index_output< P, Ops, SpoolOps >::secondary_

private

spool_

template<class P , class Ops , class SpoolOps >

spool_type everett::cola_detail::file_index_output< P, Ops, SpoolOps >::spool_

private

stream_

template<class P , class Ops , class SpoolOps >

stream_type everett::cola_detail::file_index_output< P, Ops, SpoolOps >::stream_

private

---

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

• include/everett/cola_file_index.h