#include <cola_sections.h>

Public Types
using	policy_type = P

using	borrowed_view = profile_view< P, stream_role::borrowed >

using	rank_view = rank_groups_view< P::group_size >

Public Member Functions
bool	active () const noexcept

borrowed_view	borrowed (unsigned route) const &

borrowed_view	borrowed (unsigned) const &&=delete

rank_view	interleave (unsigned route) const &

rank_view	interleave (unsigned) const &&=delete

std::span< std::byte const >	false_borrow_bits (unsigned route) const &

std::span< std::byte const >	false_borrow_bits (unsigned) const &&=delete

word_view	cut_lcps (unsigned route) const &

word_view	cut_lcps (unsigned) const &&=delete

object_id const &	native_id () const &

object_id const &	native_id () const &&=delete

std::optional< blob_identity > const &	main_id () const &

std::optional< blob_identity > const &	main_id () const &&=delete

std::optional< object_id > const &	secondary_id () const &

std::optional< object_id > const &	secondary_id () const &&=delete

std::uint64_t	virtual_size () const

cola_section_detail::directory const &	layout () const &

cola_section_detail::directory const &	layout () const &&=delete

std::span< std::byte const >	section (std::size_t slot) const &

std::span< std::byte const >	section (std::size_t) const &&=delete

cola_index_view< P >	view (profile_view< P, stream_role::native > native) const &

cola_index_view< P >	view (profile_view< P, stream_role::native >) const &&=delete

void	scan () const

Static Public Member Functions
static mapped_cola_index	open (file< P > source)

static mapped_cola_index	open (std::filesystem::path const &path)

static mapped_cola_index	from_slice (mapped_slice source, file_open_mode mode=file_open_mode::checked)

Private Member Functions
	mapped_cola_index (file< P > source, mapped_slice body, cola_section_detail::directory layout, std::array< borrowed_view, 2 > profiles, std::array< rank_view, 2 > ranks, std::array< std::span< std::byte const >, 2 > flags, std::array< word_view, 2 > cuts)

void	require_active () const

Private Attributes
file< P >	source_

mapped_slice	body_

cola_section_detail::directory	layout_

std::array< borrowed_view, 2 >	profiles_

std::array< rank_view, 2 >	ranks_

std::array< std::span< std::byte const >, 2 >	flags_

std::array< word_view, 2 >	cuts_

Member Typedef Documentation

◆ borrowed_view

template<class P >

using everett::mapped_cola_index::borrowed_view = profile_view<P, stream_role::borrowed>

◆ policy_type

template<class P >

using everett::mapped_cola_index::policy_type = P

◆ rank_view

template<class P >

using everett::mapped_cola_index::rank_view = rank_groups_view<P::group_size>

Constructor & Destructor Documentation

◆ mapped_cola_index()

template<class P >

everett::mapped_cola_index< P >::mapped_cola_index	(	file< P >	source,
		mapped_slice	body,
		cola_section_detail::directory	layout,
		std::array< borrowed_view, 2 >	profiles,
		std::array< rank_view, 2 >	ranks,
		std::array< std::span< std::byte const >, 2 >	flags,
		std::array< word_view, 2 >	cuts
	)

inlineprivate

Member Function Documentation

◆ active()

template<class P >

bool everett::mapped_cola_index::active ( ) const

inlinenoexcept

◆ borrowed() [1/2]

template<class P >

borrowed_view everett::mapped_cola_index::borrowed ( unsigned route ) const &

inline

◆ borrowed() [2/2]

template<class P >

borrowed_view everett::mapped_cola_index::borrowed ( unsigned ) const &&

delete

◆ cut_lcps() [1/2]

template<class P >

word_view everett::mapped_cola_index::cut_lcps ( unsigned route ) const &

inline

◆ cut_lcps() [2/2]

template<class P >

word_view everett::mapped_cola_index::cut_lcps ( unsigned ) const &&

delete

◆ false_borrow_bits() [1/2]

template<class P >

std::span< std::byte const > everett::mapped_cola_index::false_borrow_bits ( unsigned route ) const &

inline

◆ false_borrow_bits() [2/2]

template<class P >

std::span< std::byte const > everett::mapped_cola_index::false_borrow_bits ( unsigned ) const &&

delete

◆ from_slice()

template<class P >

static mapped_cola_index everett::mapped_cola_index< P >::from_slice	(	mapped_slice	source,
		file_open_mode	mode = `file_open_mode::checked`
	)

inlinestatic

◆ interleave() [1/2]

template<class P >

rank_view everett::mapped_cola_index::interleave ( unsigned route ) const &

inline

◆ interleave() [2/2]

template<class P >

rank_view everett::mapped_cola_index::interleave ( unsigned ) const &&

delete

◆ layout() [1/2]

template<class P >

cola_section_detail::directory const & everett::mapped_cola_index::layout ( ) const &

inline

◆ layout() [2/2]

template<class P >

cola_section_detail::directory const & everett::mapped_cola_index::layout ( ) const &&

delete

◆ main_id() [1/2]

template<class P >

std::optional< blob_identity > const & everett::mapped_cola_index::main_id ( ) const &

inline

◆ main_id() [2/2]

template<class P >

std::optional< blob_identity > const & everett::mapped_cola_index::main_id ( ) const &&

delete

◆ native_id() [1/2]

template<class P >

object_id const & everett::mapped_cola_index::native_id ( ) const &

inline

◆ native_id() [2/2]

template<class P >

object_id const & everett::mapped_cola_index::native_id ( ) const &&

delete

◆ open() [1/2]

template<class P >

static mapped_cola_index everett::mapped_cola_index::open ( file source )

inlinestatic

◆ open() [2/2]

template<class P >

static mapped_cola_index everett::mapped_cola_index::open ( std::filesystem::path const & path )

inlinestatic

◆ require_active()

template<class P >

void everett::mapped_cola_index::require_active ( ) const

inlineprivate

◆ scan()

template<class P >

void everett::mapped_cola_index::scan ( ) const

inline

◆ secondary_id() [1/2]

template<class P >

std::optional< object_id > const & everett::mapped_cola_index::secondary_id ( ) const &

inline

◆ secondary_id() [2/2]

template<class P >

std::optional< object_id > const & everett::mapped_cola_index::secondary_id ( ) const &&

delete

◆ section() [1/2]

template<class P >

std::span< std::byte const > everett::mapped_cola_index::section ( std::size_t slot ) const &

inline

◆ section() [2/2]

template<class P >

std::span< std::byte const > everett::mapped_cola_index::section ( std::size_t ) const &&

delete

◆ view() [1/2]

template<class P >

cola_index_view everett::mapped_cola_index::view ( profile_view< P, stream_role::native > native ) const &

inline

◆ view() [2/2]

template<class P >

cola_index_view everett::mapped_cola_index::view ( profile_view< P, stream_role::native > ) const &&

delete

◆ virtual_size()

template<class P >

std::uint64_t everett::mapped_cola_index::virtual_size ( ) const

inline

Member Data Documentation

◆ body_

template<class P >

mapped_slice everett::mapped_cola_index::body_

private

◆ cuts_

template<class P >

std::array<word_view, 2> everett::mapped_cola_index::cuts_

private

◆ flags_

template<class P >

std::array<std::span<std::byte const>, 2> everett::mapped_cola_index::flags_

private

◆ layout_

template<class P >

cola_section_detail::directory everett::mapped_cola_index::layout_

private

◆ profiles_

template<class P >

std::array<borrowed_view, 2> everett::mapped_cola_index::profiles_

private

◆ ranks_

template<class P >

std::array<rank_view, 2> everett::mapped_cola_index::ranks_

private

◆ source_

template<class P >

file everett::mapped_cola_index::source_

private

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

include/everett/cola_sections.h

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ borrowed_view

◆ policy_type

◆ rank_view

Constructor & Destructor Documentation

◆ mapped_cola_index()

Member Function Documentation

◆ active()

◆ borrowed() [1/2]

◆ borrowed() [2/2]

◆ cut_lcps() [1/2]

◆ cut_lcps() [2/2]

◆ false_borrow_bits() [1/2]

◆ false_borrow_bits() [2/2]

◆ from_slice()

◆ interleave() [1/2]

◆ interleave() [2/2]

◆ layout() [1/2]

◆ layout() [2/2]

◆ main_id() [1/2]

◆ main_id() [2/2]

◆ native_id() [1/2]

◆ native_id() [2/2]

◆ open() [1/2]

◆ open() [2/2]

◆ require_active()

◆ scan()

◆ secondary_id() [1/2]

◆ secondary_id() [2/2]

◆ section() [1/2]

◆ section() [2/2]

◆ view() [1/2]

◆ view() [2/2]

◆ virtual_size()

Member Data Documentation

◆ body_

◆ cuts_

◆ flags_

◆ layout_

◆ profiles_

◆ ranks_

◆ source_