A slice of contiguous memory, prefixed by and header containing size and capacity. More...

#include <Segment.h>

Inheritance diagram for SC::Segment< VTable >:

Public Types
using	T = typename VTable::Type

Public Member Functions
	Segment (uint32_t capacityInBytes, SegmentAllocator allocator=SegmentAllocator::Global) noexcept

	Segment (Segment &&other) noexcept

	Segment (const Segment &other) noexcept

Segment &	operator= (Segment &&other) noexcept

Segment &	operator= (const Segment &other) noexcept

template<typename U = T>
	Segment (Span< const U > span) noexcept

	Segment (std::initializer_list< T > list) noexcept

bool	resizeWithoutInitializing (size_t newSize) noexcept
	Re-allocates to the requested new size, preserving its contents.

bool	resize (size_t newSize, const T &value=T()) noexcept
	Re-allocates to the requested new size, preserving its contents and setting new items to value.

bool	reserve (size_t capacity) noexcept
	Reserves capacity to avoid heap-allocation during a future append, assign or resize.

template<typename U = T>
bool	append (Span< const U > span) noexcept
	Appends a Span of items convertible to T to the end of the segment.

template<typename VTable2 >
bool	appendMove (Segment< VTable2 > &&other) noexcept
	Moves contents of another segment to the end of this segment.

bool	shrink_to_fit () noexcept
	Ensures `capacity == size` re-allocating (if `capacity>size`) or freeing ( if `size==0`) memory.

void	clear () noexcept
	Sets size to zero without freeing any memory (use `shrink_to_fit()` to free memory)

template<typename U = T>
bool	assign (Span< const U > span) noexcept
	Replaces contents with contents of the span.

template<typename VTable2 >
bool	assignMove (Segment< VTable2 > &&other) noexcept
	Replaces content moving (possibly "stealing") content of another segment.

bool	push_back (const T &value) noexcept
	Appends a single element to the end of the segment.

bool	push_back (T &&value) noexcept
	Moves a single element to the end of the segment.

bool	push_front (const T &value) noexcept
	Appends a single element to the start of the segment.

bool	pop_back (T *removedValue=nullptr) noexcept
	Removes the last element of the segment.

bool	pop_front (T *removedValue=nullptr) noexcept
	Removes the first element of the segment.

T *	begin () noexcept SC_LANGUAGE_LIFETIME_BOUND

const T *	begin () const noexcept SC_LANGUAGE_LIFETIME_BOUND

T *	end () noexcept SC_LANGUAGE_LIFETIME_BOUND

const T *	end () const noexcept SC_LANGUAGE_LIFETIME_BOUND

T &	back () noexcept SC_LANGUAGE_LIFETIME_BOUND

T &	front () noexcept SC_LANGUAGE_LIFETIME_BOUND

const T &	back () const noexcept SC_LANGUAGE_LIFETIME_BOUND

const T &	front () const noexcept SC_LANGUAGE_LIFETIME_BOUND

T &	operator[] (size_t idx) noexcept SC_LANGUAGE_LIFETIME_BOUND

const T &	operator[] (size_t idx) const noexcept SC_LANGUAGE_LIFETIME_BOUND

bool	isEmpty () const noexcept
	Check if is empty (`size()` == 0)

Span< T >	toSpan () noexcept SC_LANGUAGE_LIFETIME_BOUND
	Obtains a Span of internal contents.

Span< const T >	toSpanConst () const noexcept SC_LANGUAGE_LIFETIME_BOUND
	Obtains a Span of internal contents.

size_t	size () const noexcept
	Returns current size.

size_t	capacity () const noexcept
	Returns current capacity (always >= of `size()`)

bool	removeRange (size_t start, size_t length) noexcept
	Removes the range [start, start + length] from the segment.

bool	removeAt (size_t index) noexcept
	Removes the element at index.

bool	insert (size_t index, Span< const T > data) noexcept
	Insert a span at the given index.

Detailed Description

template<typename VTable>
struct SC::Segment< VTable >

A slice of contiguous memory, prefixed by and header containing size and capacity.

Can act as a simple byte buffer or more of a "vector-like" class depending on the passed in VTable traits. It transparently handles going to and from an inline buffer (defined in derived classes) and the heap.

Template Parameters

VTable provides copy / move / destruct operations (see SC::SegmentTrivial as an example)

Note: Implementation is in .inl to reduce include bloat for non-templated derived classes like SC::Buffer. This reduces header bloat as the .inl can be included where derived class is defined (typically a .cpp file).

Member Function Documentation

◆ append()

template<typename VTable >

template<typename U = T>

bool SC::Segment< VTable >::append ( Span< const U > span )

nodiscardnoexcept

Appends a Span of items convertible to T to the end of the segment.

◆ appendMove()

template<typename VTable >

template<typename VTable2 >

bool SC::Segment< VTable >::appendMove ( Segment< VTable2 > && other )

nodiscardnoexcept

Moves contents of another segment to the end of this segment.

◆ assign()

template<typename VTable >

template<typename U = T>

bool SC::Segment< VTable >::assign ( Span< const U > span )

nodiscardnoexcept

Replaces contents with contents of the span.

Note: This method allows detecting allocation failures (unlike the assignment operator)

◆ assignMove()

template<typename VTable >

template<typename VTable2 >

bool SC::Segment< VTable >::assignMove ( Segment< VTable2 > && other )

nodiscardnoexcept

Replaces content moving (possibly "stealing") content of another segment.

Note: This method allows detecting allocation failures (unlike the assignment operator)

◆ capacity()

template<typename VTable >

size_t SC::Segment< VTable >::capacity ( ) const

inlinenodiscardnoexcept

Returns current capacity (always >= of size())

◆ clear()

template<typename VTable >

void SC::Segment< VTable >::clear ( )

noexcept

Sets size to zero without freeing any memory (use shrink_to_fit() to free memory)

◆ insert()

template<typename VTable >

bool SC::Segment< VTable >::insert	(	size_t	index,
		Span< const T >	data )

nodiscardnoexcept

Insert a span at the given index.

Parameters

index	Index where span should be inserted
data	Data that will be inserted at index `idx` (by copy)

Returns: true if index is less than or equal to size()

◆ isEmpty()

template<typename VTable >

bool SC::Segment< VTable >::isEmpty ( ) const

inlinenodiscardnoexcept

Check if is empty (size() == 0)

◆ pop_back()

template<typename VTable >

bool SC::Segment< VTable >::pop_back ( T * removedValue = nullptr )

nodiscardnoexcept

Removes the last element of the segment.

Parameters

removedValue Last item will be moved in the value if != nullptr

Returns: true if element was successfully removed (false if segment is empty)

◆ pop_front()

template<typename VTable >

bool SC::Segment< VTable >::pop_front ( T * removedValue = nullptr )

nodiscardnoexcept

Removes the first element of the segment.

Parameters

removedValue First item will be moved in the value if != nullptr

Returns: true if element was successfully removed (false if segment is empty)

◆ push_back() [1/2]

template<typename VTable >

bool SC::Segment< VTable >::push_back ( const T & value )

inlinenodiscardnoexcept

Appends a single element to the end of the segment.

◆ push_back() [2/2]

template<typename VTable >

bool SC::Segment< VTable >::push_back ( T && value )

nodiscardnoexcept

Moves a single element to the end of the segment.

◆ push_front()

template<typename VTable >

bool SC::Segment< VTable >::push_front ( const T & value )

inlinenodiscardnoexcept

Appends a single element to the start of the segment.

◆ removeAt()

template<typename VTable >

bool SC::Segment< VTable >::removeAt ( size_t index )

inlinenodiscardnoexcept

Removes the element at index.

Parameters

index Index where the item must be removed

Returns: true if index is within bounds

◆ removeRange()

template<typename VTable >

bool SC::Segment< VTable >::removeRange	(	size_t	start,
		size_t	length )

nodiscardnoexcept

Removes the range [start, start + length] from the segment.

Parameters

start	Index where the item must be removed
length	Number of elements that will be removed

Returns: true if start + length is within bounds

◆ reserve()

template<typename VTable >

bool SC::Segment< VTable >::reserve ( size_t capacity )

nodiscardnoexcept

Reserves capacity to avoid heap-allocation during a future append, assign or resize.

◆ resize()

template<typename VTable >

bool SC::Segment< VTable >::resize	(	size_t	newSize,
		const T &	value = T() )

nodiscardnoexcept

Re-allocates to the requested new size, preserving its contents and setting new items to value.

◆ resizeWithoutInitializing()

template<typename VTable >

bool SC::Segment< VTable >::resizeWithoutInitializing ( size_t newSize )

nodiscardnoexcept

Re-allocates to the requested new size, preserving its contents.

Note: To restore link with an inline buffer, resize to its capacity (or less) and call Segment::shrink

◆ shrink_to_fit()

template<typename VTable >

bool SC::Segment< VTable >::shrink_to_fit ( )

nodiscardnoexcept

Ensures capacity == size re-allocating (if capacity>size) or freeing ( if size==0) memory.

Note: If isInline() == true its capacity will not shrink.

◆ size()

template<typename VTable >

size_t SC::Segment< VTable >::size ( ) const

inlinenodiscardnoexcept

Returns current size.

◆ toSpan()

template<typename VTable >

Span< T > SC::Segment< VTable >::toSpan ( )

inlinenodiscardnoexcept

Obtains a Span of internal contents.

◆ toSpanConst()

template<typename VTable >

Span< const T > SC::Segment< VTable >::toSpanConst ( ) const

inlinenodiscardnoexcept

Obtains a Span of internal contents.

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

Segment.h

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ append()

◆ appendMove()

◆ assign()

◆ assignMove()

◆ capacity()

◆ clear()

◆ insert()

◆ isEmpty()

◆ pop_back()

◆ pop_front()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ push_front()

◆ removeAt()

◆ removeRange()

◆ reserve()

◆ resize()

◆ resizeWithoutInitializing()

◆ shrink_to_fit()

◆ size()

◆ toSpan()

◆ toSpanConst()