#include <Ref.hpp>

Inheritance diagram for ae2f::Ds::Alloc::cRefer:

Public Member Functions
ae2f_errint_t	Read (size_t idx, void *buff, size_t elsize) const noexcept
	Gets data from a class.

ae2f_errint_t	Write (size_t idx, const void *src, size_t srcsize) noexcept
	Sets data to a class.

ae2f_errint_t	Length (size_t sizebuff, size_t elsizebuff) const noexcept
	Gets the length, and element size of the class.

constexpr	cRefer (const rRefer &r) noexcept
	Initialises the class for reffering.

constexpr	cRefer (const rRefer &&r) noexcept
	Initialises the class for reffering.

constexpr	cRefer (const xrOwner &r) noexcept
	Initialises the class for reffering.

constexpr	cRefer () noexcept
	A constructor for instance of class without any implementations.

Detailed Description

This structure does not own the memory.

An interface to implement the linear array.

See also: ae2f_ds_cAlloc; ae2f_ds_Alloc_cRef; ae2f::Ds::Alloc::rRefer

Constructor & Destructor Documentation

◆ cRefer() [1/4]

ae2f::Ds::Alloc::cRefer::cRefer ( const rRefer & r )

inlineconstexprnoexcept

Initialises the class for reffering.

Parameters

r	{const ae2f_ds_cAlloc*}

Returns: {const ae2f_ds_Alloc_cRef} This initiated structure.

Warning: You need to suggest that returning value of this does not own the memory.

See also: ae2f_ds_Alloc_cRef; ae2f_ds_Alloc_cRef_Mk

◆ cRefer() [2/4]

ae2f::Ds::Alloc::cRefer::cRefer ( const rRefer && r )

inlineconstexprnoexcept

Initialises the class for reffering.

Parameters

r	{const ae2f_ds_cAlloc*}

Returns: {const ae2f_ds_Alloc_cRef} This initiated structure.

Warning: You need to suggest that returning value of this does not own the memory.

See also: ae2f_ds_Alloc_cRef; ae2f_ds_Alloc_cRef_Mk

◆ cRefer() [3/4]

ae2f::Ds::Alloc::cRefer::cRefer ( const xrOwner & r )

constexprnoexcept

Initialises the class for reffering.

Parameters

r	{const ae2f_ds_cAlloc*}

Returns: {const ae2f_ds_Alloc_cRef} This initiated structure.

Warning: You need to suggest that returning value of this does not own the memory.

See also: ae2f_ds_Alloc_cRef; ae2f_ds_Alloc_cRef_Mk

◆ cRefer() [4/4]

ae2f::Ds::Alloc::cRefer::cRefer ( )

inlineconstexprnoexcept

A constructor for instance of class without any implementations.

Warning: Notice that will have no implementation.

Member Function Documentation

◆ Length()

ae2f_errint_t ae2f::Ds::Alloc::cRefer::Length	(	size_t *	sizebuff,
		size_t *	elsizebuff ) const

inlinenoexcept

Gets the length, and element size of the class.

Parameters

sizebuff	A pointer where the count of the array, as an unit of elements.
elsizebuff	A pointer where the size of the element.

Returns: ae2f_errGlob_OK
ae2f_ds_Alloc_Err_NCOPIED

Exceptions

ae2f_errGlob_PTR_IS_NULL

See also: ae2f_ds_Alloc_cRef; ae2f_ds_Alloc_fpLen_t; ae2f_ds_Alloc_cRef_getSize

◆ Read()

ae2f_errint_t ae2f::Ds::Alloc::cRefer::Read	(	size_t	idx,
		void *	buff,
		size_t	elsize ) const

inlinenoexcept

Gets data from a class.

Parameters

idx	The Index [in an unit of bytes] where the element to copy is.
buff	A pointer of buffer where the element to be copied.
elsize	The allocated size of the [buff].