Skip to content

Struct mdbx::to_base58

ClassList > mdbx > to_base58

Base58 encoder which satisfySliceTranscoder concept.

  • #include <mdbx.h++>

Public Attributes

Type Name
const slice source
const unsigned wrap_width = 0

Public Functions

Type Name
size_t envisage_result_length () noexcept const
Returns the buffer size in bytes needed for Base58 dump of passed slice.
bool is_empty () noexcept const
Checks whether a passed slice is empty, and therefore there will be no output bytes.
bool is_erroneous () noexcept const
Checks whether the content of a passed slice could be encoded; always returns false for the Base58 encoder.
::std::ostream & output (::std::ostream & out) const
Output Base58 dump of passed slice to the std::ostream.
constexpr to_base58 (const slice & source, unsigned wrap_width=0) noexcept
char * write_bytes (char * dest, size_t dest_size) const
Fills the buffer by Base58 dump of passed slice.

Public Attributes Documentation

variable source

const slice mdbx::to_base58::source;

variable wrap_width

const unsigned mdbx::to_base58::wrap_width;

Public Functions Documentation

function envisage_result_length

Returns the buffer size in bytes needed for Base58 dump of passed slice.

inline size_t mdbx::to_base58::envisage_result_length () noexcept const

function is_empty

Checks whether a passed slice is empty, and therefore there will be no output bytes.

inline bool mdbx::to_base58::is_empty () noexcept const

function is_erroneous

Checks whether the content of a passed slice could be encoded; always returns false for the Base58 encoder.

inline bool mdbx::to_base58::is_erroneous () noexcept const

function output

Output Base58 dump of passed slice to the std::ostream.

::std::ostream & mdbx::to_base58::output (
    ::std::ostream & out
) const

Exception:

  • std::ios_base::failure corresponding to std::ostream::write() behaviour.

function to_base58

inline constexpr mdbx::to_base58::to_base58 (
    const slice & source,
    unsigned wrap_width=0
) noexcept

function write_bytes

Fills the buffer by Base58 dump of passed slice.

char * mdbx::to_base58::write_bytes (
    char * dest,
    size_t dest_size
) const

Exception:

  • std::length_error if given buffer is too small.


The documentation for this class was generated from the following file docs/mdbx.h++