Everett
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
everett::word_view Struct Reference

#include <word_view.h>

Public Member Functions

 word_view ()=default
 
 word_view (std::span< std::uint64_t const > words) noexcept
 
std::size_t size () const noexcept
 
bool empty () const noexcept
 
std::span< std::byte const > bytes () const noexcept
 
bool is_little_endian () const noexcept
 
word_view subspan (std::size_t offset, std::size_t count=std::dynamic_extent) const
 
std::uint64_t operator[] (std::size_t index) const
 

Static Public Member Functions

static word_view little_endian (std::span< std::byte const > bytes)
 

Private Member Functions

 word_view (std::span< std::byte const > bytes, bool little) noexcept
 

Private Attributes

std::span< std::byte const > bytes_
 
bool little_ = true
 

Friends

struct sample_view
 

Constructor & Destructor Documentation

◆ word_view() [1/3]

everett::word_view::word_view ( )
default

◆ word_view() [2/3]

everett::word_view::word_view ( std::span< std::uint64_t const >  words)
inlineexplicitnoexcept

◆ word_view() [3/3]

everett::word_view::word_view ( std::span< std::byte const >  bytes,
bool  little 
)
inlineprivatenoexcept

Member Function Documentation

◆ bytes()

std::span< std::byte const > everett::word_view::bytes ( ) const
inlinenoexcept

◆ empty()

bool everett::word_view::empty ( ) const
inlinenoexcept

◆ is_little_endian()

bool everett::word_view::is_little_endian ( ) const
inlinenoexcept

◆ little_endian()

static word_view everett::word_view::little_endian ( std::span< std::byte const >  bytes)
inlinestatic

◆ operator[]()

std::uint64_t everett::word_view::operator[] ( std::size_t  index) const
inline

◆ size()

std::size_t everett::word_view::size ( ) const
inlinenoexcept

◆ subspan()

word_view everett::word_view::subspan ( std::size_t  offset,
std::size_t  count = std::dynamic_extent 
) const
inline

Friends And Related Symbol Documentation

◆ sample_view

friend struct sample_view
friend

Member Data Documentation

◆ bytes_

std::span<std::byte const> everett::word_view::bytes_
private

◆ little_

bool everett::word_view::little_ = true
private

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