Botan::Hex_Encoder Class Reference

#include <filters.h>

Inheritance diagram for Botan::Hex_Encoder:

Public Types
enum	Case { Uppercase, Lowercase }

Public Member Functions
virtual bool	attachable ()
void	end_msg () override
	Hex_Encoder (Case the_case)
	Hex_Encoder (bool newlines=false, size_t line_length=72, Case the_case=Uppercase)
std::string	name () const override
virtual void	start_msg ()
void	write (const uint8_t in[], size_t length) override

Protected Member Functions
virtual void	send (const uint8_t in[], size_t length)
void	send (uint8_t in)
template<typename Alloc >
void	send (const std::vector< uint8_t, Alloc > &in)
template<typename Alloc >
void	send (const std::vector< uint8_t, Alloc > &in, size_t length)

Detailed Description

Converts arbitrary binary data to hex strings, optionally with newlines inserted

Definition at line 577 of file filters.h.

Member Enumeration Documentation

enum Botan::Hex_Encoder::Case

Whether to use uppercase or lowercase letters for the encoded string.

Enumerator
Uppercase
Lowercase

Definition at line 583 of file filters.h.

{ Uppercase, Lowercase };

Constructor & Destructor Documentation

Botan::Hex_Encoder::Hex_Encoder ( Case  the_case )

explicit

Create a hex encoder.

Parameters

the_case

the case to use in the encoded strings.

Definition at line 34 of file hex_filt.cpp.

                               : m_casing(c), m_line_length(0)
   {
   m_in.resize(HEX_CODEC_BUFFER_SIZE);
   m_out.resize(2*m_in.size());
   m_counter = m_position = 0;
   }

Botan::Hex_Encoder::Hex_Encoder	(	bool	newlines = false,
		size_t	line_length = 72,
		Case	the_case = Uppercase
	)

Create a hex encoder.

Parameters

newlines	should newlines be used
line_length	if newlines are used, how long are lines
the_case	the case to use in the encoded strings

Definition at line 23 of file hex_filt.cpp.

                                                           :
   m_casing(c), m_line_length(breaks ? length : 0)
   {
   m_in.resize(HEX_CODEC_BUFFER_SIZE);
   m_out.resize(2*m_in.size());
   m_counter = m_position = 0;
   }

Member Function Documentation

virtual bool Botan::Filter::attachable ( )

inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented in Botan::SecureQueue, and Botan::DataSink.

Definition at line 52 of file filter.h.

{ return true; }

void Botan::Hex_Encoder::end_msg ( )

overridevirtual

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented from Botan::Filter.

Definition at line 97 of file hex_filt.cpp.

References Botan::Filter::send().

   {
   encode_and_send(m_in.data(), m_position);
   if(m_counter && m_line_length)
      send('\n');
   m_counter = m_position = 0;
   }

std::string Botan::Hex_Encoder::name ( ) const

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 585 of file filters.h.

{ return "Hex_Encoder"; }

void Botan::Filter::send ( const uint8_t  in[], size_t  length  )

protectedvirtualinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 27 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::Base64_Encoder::end_msg(), Botan::Base64_Decoder::end_msg(), end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::write(), and Botan::Hex_Decoder::write().

   {
   if(!length)
      return;

   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(m_next[j])
         {
         if(m_write_queue.size())
            m_next[j]->write(m_write_queue.data(), m_write_queue.size());
         m_next[j]->write(input, length);
         nothing_attached = false;
         }

   if(nothing_attached)
      m_write_queue += std::make_pair(input, length);
   else
      m_write_queue.clear();
   }

void Botan::Filter::send ( uint8_t  in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in, 1); }

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 71 of file filter.h.

         {
         send(in.data(), in.size());
         }

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  in, size_t  length  )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 81 of file filter.h.

References BOTAN_ASSERT_NOMSG.

         {
         BOTAN_ASSERT_NOMSG(length <= in.size());
         send(in.data(), length);
         }

virtual void Botan::Filter::start_msg ( )

inlinevirtualinherited

Start a new message. Must be closed by end_msg() before another message can be started.

Definition at line 40 of file filter.h.

{ /* default empty */ }

void Botan::Hex_Encoder::write ( const uint8_t  input[], size_t  length  )

overridevirtual

Write a portion of a message to this filter.

Parameters

input	the input as a byte array
length	the length of the byte array input

Implements Botan::Filter.

Definition at line 74 of file hex_filt.cpp.

References Botan::buffer_insert(), and Botan::copy_mem().

   {
   buffer_insert(m_in, m_position, input, length);
   if(m_position + length >= m_in.size())
      {
      encode_and_send(m_in.data(), m_in.size());
      input += (m_in.size() - m_position);
      length -= (m_in.size() - m_position);
      while(length >= m_in.size())
         {
         encode_and_send(input, m_in.size());
         input += m_in.size();
         length -= m_in.size();
         }
      copy_mem(m_in.data(), input, length);
      m_position = 0;
      }
   m_position += length;
   }

---

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

• src/lib/filters/filters.h
• src/lib/filters/hex_filt.cpp