Bitcoin Core  22.99.0
P2P Digital Currency
Classes | Macros | Functions
span.h File Reference
#include <type_traits>
#include <cstddef>
#include <algorithm>
#include <assert.h>
Include dependency graph for span.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Span< C >
 A Span is an object that can refer to a contiguous sequence of objects. More...
 
struct  Span< C >::is_Span_int< T >
 
struct  Span< C >::is_Span_int< Span< T > >
 
struct  Span< C >::is_Span< T >
 

Macros

#define CONSTEXPR_IF_NOT_DEBUG   constexpr
 
#define ASSERT_IF_DEBUG(x)
 
#define SPAN_ATTR_LIFETIMEBOUND
 

Functions

template<typename T , typename EndOrSize >
 Span (T *, EndOrSize) -> Span< T >
 
template<typename T , std::size_t N>
 Span (T(&)[N]) -> Span< T >
 
template<typename T >
 Span (T &&) -> Span< std::enable_if_t<!std::is_lvalue_reference_v< T >, const std::remove_pointer_t< decltype(std::declval< T && >().data())>>>
 
template<typename T >
 Span (T &) -> Span< std::remove_pointer_t< decltype(std::declval< T & >().data())>>
 
template<typename T >
T & SpanPopBack (Span< T > &span)
 Pop the last element off a span, and return a reference to that element. More...
 
const std::byte * BytePtr (const void *data)
 Convert a data pointer to a std::byte data pointer. More...
 
std::byte * BytePtr (void *data)
 
template<typename T >
Span< const std::byte > AsBytes (Span< T > s) noexcept
 
template<typename T >
Span< std::byte > AsWritableBytes (Span< T > s) noexcept
 
template<typename V >
Span< const std::byte > MakeByteSpan (V &&v) noexcept
 
template<typename V >
Span< std::byte > MakeWritableByteSpan (V &&v) noexcept
 
unsigned char * UCharCast (char *c)
 
unsigned char * UCharCast (unsigned char *c)
 
const unsigned char * UCharCast (const char *c)
 
const unsigned char * UCharCast (const unsigned char *c)
 
const unsigned char * UCharCast (const std::byte *c)
 
template<typename T >
constexpr auto UCharSpanCast (Span< T > s) -> Span< typename std::remove_pointer< decltype(UCharCast(s.data()))>::type >
 
template<typename V >
constexpr auto MakeUCharSpan (V &&v) -> decltype(UCharSpanCast(Span
 Like the Span constructor, but for (const) unsigned char member types only. More...
 

Macro Definition Documentation

◆ ASSERT_IF_DEBUG

#define ASSERT_IF_DEBUG (   x)

Definition at line 18 of file span.h.

◆ CONSTEXPR_IF_NOT_DEBUG

#define CONSTEXPR_IF_NOT_DEBUG   constexpr

Definition at line 17 of file span.h.

◆ SPAN_ATTR_LIFETIMEBOUND

#define SPAN_ATTR_LIFETIMEBOUND

Definition at line 28 of file span.h.

Function Documentation

◆ AsBytes()

template<typename T >
Span<const std::byte> AsBytes ( Span< T >  s)
noexcept

Definition at line 253 of file span.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AsWritableBytes()

template<typename T >
Span<std::byte> AsWritableBytes ( Span< T >  s)
noexcept

Definition at line 258 of file span.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ BytePtr() [1/2]

const std::byte* BytePtr ( const void *  data)
inline

Convert a data pointer to a std::byte data pointer.

Where possible, please use the safer AsBytes helpers.

Definition at line 248 of file span.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ BytePtr() [2/2]

std::byte* BytePtr ( void *  data)
inline

Definition at line 249 of file span.h.

Here is the call graph for this function:

◆ MakeByteSpan()

template<typename V >
Span<const std::byte> MakeByteSpan ( V &&  v)
noexcept

Definition at line 264 of file span.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MakeUCharSpan()

template<typename V >
constexpr auto MakeUCharSpan ( V &&  v) -> decltype(UCharSpanCast(Span
constexpr

Like the Span constructor, but for (const) unsigned char member types only.

Only works for (un)signed char containers.

Definition at line 285 of file span.h.

Here is the caller graph for this function:

◆ MakeWritableByteSpan()

template<typename V >
Span<std::byte> MakeWritableByteSpan ( V &&  v)
noexcept

Definition at line 269 of file span.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Span() [1/4]

template<typename T >
Span ( T &&  ) -> Span< std::enable_if_t<!std::is_lvalue_reference_v< T >, const std::remove_pointer_t< decltype(std::declval< T && >().data())>>>

◆ Span() [2/4]

template<typename T >
Span ( T &  ) -> Span< std::remove_pointer_t< decltype(std::declval< T & >().data())>>

◆ Span() [3/4]

template<typename T , typename EndOrSize >
Span ( T *  ,
EndOrSize   
) -> Span< T >

◆ Span() [4/4]

template<typename T , std::size_t N>
Span ( T(&)  [N]) -> Span< T >

◆ SpanPopBack()

template<typename T >
T& SpanPopBack ( Span< T > &  span)

Pop the last element off a span, and return a reference to that element.

Definition at line 237 of file span.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ UCharCast() [1/5]

unsigned char* UCharCast ( char *  c)
inline

Definition at line 275 of file span.h.

Here is the caller graph for this function:

◆ UCharCast() [2/5]

const unsigned char* UCharCast ( const char *  c)
inline

Definition at line 277 of file span.h.

◆ UCharCast() [3/5]

const unsigned char* UCharCast ( const std::byte *  c)
inline

Definition at line 279 of file span.h.

◆ UCharCast() [4/5]

const unsigned char* UCharCast ( const unsigned char *  c)
inline

Definition at line 278 of file span.h.

◆ UCharCast() [5/5]

unsigned char* UCharCast ( unsigned char *  c)
inline

Definition at line 276 of file span.h.

◆ UCharSpanCast()

template<typename T >
constexpr auto UCharSpanCast ( Span< T >  s) -> Span<typename std::remove_pointer<decltype(UCharCast(s.data()))>::type>
constexpr

Definition at line 282 of file span.h.

Here is the call graph for this function: