StormByte::Crypto::Hasher::SHA3_256 Class Reference

A SHA3_256 hasher class. More...

#include <sha3_256.hxx>

Inheritance diagram for StormByte::Crypto::Hasher::SHA3_256:

Collaboration diagram for StormByte::Crypto::Hasher::SHA3_256:

Public Member Functions
	SHA3_256 ()
	Constructor.
	SHA3_256 (const SHA3_256 &other)=default
	Copy constructor.
	SHA3_256 (SHA3_256 &&other) noexcept=default
	Move constructor.
virtual	~SHA3_256 () noexcept=default
	Virtual destructor.
SHA3_256 &	operator= (const SHA3_256 &other)=default
	Copy assignment operator.
SHA3_256 &	operator= (SHA3_256 &&other) noexcept=default
	Move assignment operator.
PointerType	Clone () const noexcept override
	Clone the SHA3_256 hasher.
PointerType	Move () noexcept override
	Move the SHA3_256 hasher.
Public Member Functions inherited from StormByte::Crypto::Hasher::Generic
	Generic (const Generic &other)=default
	Copy constructor.
	Generic (Generic &&other) noexcept=default
	Move constructor.
virtual	~Generic () noexcept=default
	Virtual destructor.
Generic &	operator= (const Generic &other)=default
	Copy assignment operator.
Generic &	operator= (Generic &&other) noexcept=default
	Move assignment operator.
bool	Hash (std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
	Hash data from input buffer to output buffer.
bool	Hash (const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Hash data from input buffer to output buffer.
bool	Hash (Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
	Hash data from input buffer to output buffer, moving the input data.
Buffer::Consumer	Hash (Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
	Hash data from a Consumer buffer.
enum Type	Type () const noexcept
	Gets the type of hasher.

Additional Inherited Members
Protected Member Functions inherited from StormByte::Crypto::Hasher::Generic
	Generic (enum Type type)
	Constructor.
Protected Attributes inherited from StormByte::Crypto::Hasher::Generic
enum Type	m_type
	The type of hasher.

Detailed Description

A SHA3_256 hasher class.

Constructor & Destructor Documentation

SHA3_256() [1/3]

StormByte::Crypto::Hasher::SHA3_256::SHA3_256 ( )

inline

Constructor.

Parameters

type	The type of hasher.

SHA3_256() [2/3]

StormByte::Crypto::Hasher::SHA3_256::SHA3_256 ( const SHA3_256 &  other )

default

Copy constructor.

Parameters

other

The other SHA3_256 hasher to copy from.

SHA3_256() [3/3]

StormByte::Crypto::Hasher::SHA3_256::SHA3_256 ( SHA3_256 &&  other )

defaultnoexcept

Move constructor.

Parameters

other

The other SHA3_256 hasher to move from.

Member Function Documentation

Clone()

PointerType StormByte::Crypto::Hasher::SHA3_256::Clone ( ) const

inlineoverridenoexcept

Clone the SHA3_256 hasher.

Returns

A pointer to the cloned SHA3_256 hasher.

Move()

PointerType StormByte::Crypto::Hasher::SHA3_256::Move ( )

inlineoverridenoexcept

Move the SHA3_256 hasher.

Returns

A pointer to the moved SHA3_256 hasher.

operator=() [1/2]

SHA3_256 & StormByte::Crypto::Hasher::SHA3_256::operator= ( const SHA3_256 &  other )

default

Copy assignment operator.

Parameters

other

The other SHA3_256 hasher to copy from.

Returns

Reference to this SHA3_256 hasher.

operator=() [2/2]

SHA3_256 & StormByte::Crypto::Hasher::SHA3_256::operator= ( SHA3_256 &&  other )

defaultnoexcept

Move assignment operator.

Parameters

other

The other SHA3_256 hasher to move from.

Returns

Reference to this SHA3_256 hasher.

---

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

• /home/runner/work/StormByte-Crypto/StormByte-Crypto/lib/public/StormByte/crypto/hasher/sha3_256.hxx