buffer_info Struct Reference

Information record describing a Python buffer object. More...

#include <buffer_info.h>

Classes
struct	private_ctr_tag

Public Member Functions
	buffer_info ()=default
	buffer_info (void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim, detail::any_container< ssize_t > shape_in, detail::any_container< ssize_t > strides_in, bool readonly=false)
template<typename T >
	buffer_info (T *ptr, detail::any_container< ssize_t > shape_in, detail::any_container< ssize_t > strides_in, bool readonly=false)
	buffer_info (void *ptr, ssize_t itemsize, const std::string &format, ssize_t size, bool readonly=false)
template<typename T >
	buffer_info (T *ptr, ssize_t size, bool readonly=false)
template<typename T >
	buffer_info (const T *ptr, ssize_t size, bool readonly=true)
	buffer_info (Py_buffer *view, bool ownview=true)
	buffer_info (const buffer_info &)=delete
	buffer_info (buffer_info &&other) noexcept
buffer_info &	operator= (const buffer_info &)=delete
buffer_info &	operator= (buffer_info &&rhs) noexcept
Py_buffer *	view () const
Py_buffer *&	view ()
	~buffer_info ()

Public Attributes
std::string	format
ssize_t	itemsize = 0
ssize_t	ndim = 0
void *	ptr = nullptr
bool	readonly = false
std::vector< ssize_t >	shape
ssize_t	size = 0
std::vector< ssize_t >	strides

Private Member Functions
	buffer_info (private_ctr_tag, void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim, detail::any_container< ssize_t > &&shape_in, detail::any_container< ssize_t > &&strides_in, bool readonly)

Private Attributes
Py_buffer *	m_view = nullptr
bool	ownview = false

Detailed Description

Information record describing a Python buffer object.

Definition at line 43 of file buffer_info.h.

Constructor & Destructor Documentation

buffer_info() [1/10]

buffer_info::buffer_info ( )

default

buffer_info() [2/10]

buffer_info::buffer_info ( void *  ptr, ssize_t  itemsize, const std::string &  format, ssize_t  ndim, detail::any_container< ssize_t >  shape_in, detail::any_container< ssize_t >  strides_in, bool  readonly = false  )

inline

Definition at line 57 of file buffer_info.h.

buffer_info() [3/10]

template<typename T >

buffer_info::buffer_info ( T *  ptr, detail::any_container< ssize_t >  shape_in, detail::any_container< ssize_t >  strides_in, bool  readonly = false  )

inline

Definition at line 75 of file buffer_info.h.

buffer_info() [4/10]

buffer_info::buffer_info ( void *  ptr, ssize_t  itemsize, const std::string &  format, ssize_t  size, bool  readonly = false  )

inline

Definition at line 88 of file buffer_info.h.

buffer_info() [5/10]

template<typename T >

buffer_info::buffer_info ( T *  ptr, ssize_t  size, bool  readonly = false  )

inline

Definition at line 96 of file buffer_info.h.

buffer_info() [6/10]

template<typename T >

buffer_info::buffer_info ( const T *  ptr, ssize_t  size, bool  readonly = true  )

inline

Definition at line 100 of file buffer_info.h.

buffer_info() [7/10]

buffer_info::buffer_info ( Py_buffer *  view, bool  ownview = true  )

inlineexplicit

Definition at line 104 of file buffer_info.h.

buffer_info() [8/10]

buffer_info::buffer_info ( const buffer_info &  )

delete

buffer_info() [9/10]

buffer_info::buffer_info ( buffer_info &&  other )

inlinenoexcept

Definition at line 127 of file buffer_info.h.

~buffer_info()

buffer_info::~buffer_info ( )

inline

Definition at line 143 of file buffer_info.h.

buffer_info() [10/10]

buffer_info::buffer_info ( private_ctr_tag  , void *  ptr, ssize_t  itemsize, const std::string &  format, ssize_t  ndim, detail::any_container< ssize_t > &&  shape_in, detail::any_container< ssize_t > &&  strides_in, bool  readonly  )

inlineprivate

Definition at line 156 of file buffer_info.h.

Member Function Documentation

operator=() [1/2]

buffer_info& buffer_info::operator= ( const buffer_info &  )

delete

operator=() [2/2]

buffer_info& buffer_info::operator= ( buffer_info &&  rhs )

inlinenoexcept

Definition at line 129 of file buffer_info.h.

view() [1/2]

Py_buffer* buffer_info::view ( ) const

inline

Definition at line 150 of file buffer_info.h.

view() [2/2]

Py_buffer*& buffer_info::view ( )

inline

Definition at line 151 of file buffer_info.h.

Member Data Documentation

format

std::string buffer_info::format

Definition at line 47 of file buffer_info.h.

itemsize

ssize_t buffer_info::itemsize = 0

Definition at line 45 of file buffer_info.h.

m_view

Py_buffer* buffer_info::m_view = nullptr

private

Definition at line 167 of file buffer_info.h.

ndim

ssize_t buffer_info::ndim = 0

Definition at line 49 of file buffer_info.h.

ownview

bool buffer_info::ownview = false

private

Definition at line 168 of file buffer_info.h.

ptr

void* buffer_info::ptr = nullptr

Definition at line 44 of file buffer_info.h.

readonly

bool buffer_info::readonly = false

Definition at line 53 of file buffer_info.h.

shape

std::vector<ssize_t> buffer_info::shape

Definition at line 50 of file buffer_info.h.

size

ssize_t buffer_info::size = 0

Definition at line 46 of file buffer_info.h.

strides

std::vector<ssize_t> buffer_info::strides

Definition at line 51 of file buffer_info.h.

---

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

• buffer_info.h