sparrow 0.3.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>
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>
 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
constexpr std::size_t children_size () const noexcept
 
constexpr void set_child_ownership (std::size_t child, bool ownership)
 
constexpr bool has_child_ownership (std::size_t child) const
 
constexpr void resize_children (std::size_t size)
 

Additional Inherited Members

- Protected Member Functions inherited from sparrow::children_ownership
constexpr children_ownership (std::size_t size=0)
 

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 34 of file private_data.hpp.

Member Typedef Documentation

◆ FormatType

Definition at line 38 of file private_data.hpp.

◆ MetadataType

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

Definition at line 40 of file private_data.hpp.

◆ NameType

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

Definition at line 39 of file private_data.hpp.

Constructor & Destructor Documentation

◆ arrow_schema_private_data() [1/4]

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

◆ arrow_schema_private_data() [2/4]

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/4]

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/4]

template<class F, class N, class M>
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>
sparrow::arrow_schema_private_data::arrow_schema_private_data ( F format,
N name,
M metadata,
std::size_t children_size = 0 )

Definition at line 118 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 132 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 127 of file private_data.hpp.

◆ metadata()

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

Definition at line 160 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 151 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 146 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 137 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: