sparrow 0.6.0
Loading...
Searching...
No Matches
sparrow::arrow_schema_private_data Class Reference

Private data for ArrowSchema. More...

#include <private_data.hpp>

Inheritance diagram for sparrow::arrow_schema_private_data:
[legend]
Collaboration diagram for sparrow::arrow_schema_private_data:
[legend]

Public Types

using FormatType = std::string
 
using NameType = std::optional<std::string>
 
using MetadataType = std::optional<std::string>
 

Public Member Functions

 arrow_schema_private_data ()=delete
 
 arrow_schema_private_data (const arrow_schema_private_data &)=delete
 
 arrow_schema_private_data (arrow_schema_private_data &&)=delete
 
arrow_schema_private_dataoperator= (const arrow_schema_private_data &)=delete
 
arrow_schema_private_dataoperator= (arrow_schema_private_data &&)=delete
 
 ~arrow_schema_private_data ()=default
 
template<class F, class N, class M, std::ranges::input_range CHILDREN_OWNERSHIP>
requires std::constructible_from<arrow_schema_private_data::FormatType, F> && std::constructible_from<arrow_schema_private_data::NameType, N> && std::constructible_from<arrow_schema_private_data::MetadataType, M> && std::is_same_v<std::ranges::range_value_t<CHILDREN_OWNERSHIP>, bool>
 arrow_schema_private_data (F format, N name, M metadata, const CHILDREN_OWNERSHIP &children_ownership, bool dictionary_ownership)
 
template<class F, class N, input_metadata_container M = std::vector<metadata_pair>>
requires std::constructible_from<arrow_schema_private_data::FormatType, F> && std::constructible_from<arrow_schema_private_data::NameType, N>
 arrow_schema_private_data (F format, N name, M metadata, std::size_t children_size=0)
 
const char * format_ptr () const noexcept
 
FormatTypeformat () noexcept
 
const char * name_ptr () const noexcept
 
NameTypename () noexcept
 
const char * metadata_ptr () const noexcept
 
MetadataTypemetadata () noexcept
 
- Public Member Functions inherited from sparrow::children_ownership
std::size_t children_size () const noexcept
 
void set_child_ownership (std::size_t child, bool ownership)
 
template<std::ranges::input_range CHILDREN_OWNERSHIP>
void set_children_ownership (const CHILDREN_OWNERSHIP &children_ownership_values)
 
bool has_child_ownership (std::size_t child) const
 
void resize_children (std::size_t size)
 
- Public Member Functions inherited from sparrow::dictionary_ownership
void set_dictionary_ownership (bool ownership)
 
bool has_dictionary_ownership () const
 

Additional Inherited Members

- Protected Member Functions inherited from sparrow::children_ownership
 children_ownership (std::size_t size=0)
 
template<std::ranges::input_range CHILDREN_OWNERSHIP>
requires std::is_same_v<std::ranges::range_value_t<CHILDREN_OWNERSHIP>, bool>
constexpr children_ownership (const CHILDREN_OWNERSHIP &children_ownership_values)
 
- Protected Member Functions inherited from sparrow::dictionary_ownership
 dictionary_ownership (bool ownership)
 

Detailed Description

Private data for ArrowSchema.

This struct holds the private data for ArrowSchema, including format, name and metadata strings, children, and dictionary. It is used in the Sparrow library.

Definition at line 35 of file private_data.hpp.

Member Typedef Documentation

◆ FormatType

Definition at line 40 of file private_data.hpp.

◆ MetadataType

using sparrow::arrow_schema_private_data::MetadataType = std::optional<std::string>

Definition at line 42 of file private_data.hpp.

◆ NameType

using sparrow::arrow_schema_private_data::NameType = std::optional<std::string>

Definition at line 41 of file private_data.hpp.

Constructor & Destructor Documentation

◆ arrow_schema_private_data() [1/5]

sparrow::arrow_schema_private_data::arrow_schema_private_data ( )
delete
Here is the caller graph for this function:

◆ arrow_schema_private_data() [2/5]

sparrow::arrow_schema_private_data::arrow_schema_private_data ( const arrow_schema_private_data & )
delete
Here is the call graph for this function:

◆ arrow_schema_private_data() [3/5]

sparrow::arrow_schema_private_data::arrow_schema_private_data ( arrow_schema_private_data && )
delete
Here is the call graph for this function:

◆ ~arrow_schema_private_data()

sparrow::arrow_schema_private_data::~arrow_schema_private_data ( )
default
Here is the call graph for this function:

◆ arrow_schema_private_data() [4/5]

template<class F, class N, class M, std::ranges::input_range CHILDREN_OWNERSHIP>
requires std::constructible_from<arrow_schema_private_data::FormatType, F> && std::constructible_from<arrow_schema_private_data::NameType, N> && std::constructible_from<arrow_schema_private_data::MetadataType, M> && std::is_same_v<std::ranges::range_value_t<CHILDREN_OWNERSHIP>, bool>
sparrow::arrow_schema_private_data::arrow_schema_private_data ( F format,
N name,
M metadata,
const CHILDREN_OWNERSHIP & children_ownership,
bool dictionary_ownership )

Definition at line 133 of file private_data.hpp.

Here is the call graph for this function:

◆ arrow_schema_private_data() [5/5]

template<class F, class N, input_metadata_container M>
requires std::constructible_from<arrow_schema_private_data::FormatType, F> && std::constructible_from<arrow_schema_private_data::NameType, N>
sparrow::arrow_schema_private_data::arrow_schema_private_data ( F format,
N name,
M metadata,
std::size_t children_size = 0 )

Definition at line 152 of file private_data.hpp.

Here is the call graph for this function:

Member Function Documentation

◆ format()

arrow_schema_private_data::FormatType & sparrow::arrow_schema_private_data::format ( )
inlinenodiscardnoexcept

Definition at line 166 of file private_data.hpp.

Here is the caller graph for this function:

◆ format_ptr()

const char * sparrow::arrow_schema_private_data::format_ptr ( ) const
inlinenodiscardnoexcept

Definition at line 161 of file private_data.hpp.

◆ metadata()

arrow_schema_private_data::MetadataType & sparrow::arrow_schema_private_data::metadata ( )
inlinenodiscardnoexcept

Definition at line 194 of file private_data.hpp.

Here is the caller graph for this function:

◆ metadata_ptr()

const char * sparrow::arrow_schema_private_data::metadata_ptr ( ) const
inlinenodiscardnoexcept

Definition at line 185 of file private_data.hpp.

Here is the caller graph for this function:

◆ name()

arrow_schema_private_data::NameType & sparrow::arrow_schema_private_data::name ( )
inlinenodiscardnoexcept

Definition at line 180 of file private_data.hpp.

Here is the caller graph for this function:

◆ name_ptr()

const char * sparrow::arrow_schema_private_data::name_ptr ( ) const
inlinenodiscardnoexcept

Definition at line 171 of file private_data.hpp.

Here is the caller graph for this function:

◆ operator=() [1/2]

arrow_schema_private_data & sparrow::arrow_schema_private_data::operator= ( arrow_schema_private_data && )
delete
Here is the call graph for this function:

◆ operator=() [2/2]

arrow_schema_private_data & sparrow::arrow_schema_private_data::operator= ( const arrow_schema_private_data & )
delete
Here is the call graph for this function:

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