Botan::DataSink_Stream Class Reference

#include <data_snk.h>

Inheritance diagram for Botan::DataSink_Stream:

Public Member Functions
bool	attachable () override
	DataSink_Stream (std::ostream &stream, std::string_view name="<std::ostream>")
void	end_msg () override
std::string	name () const override
virtual void	start_msg ()
void	write (const uint8_t[], size_t) override
	~DataSink_Stream () override

Protected Member Functions
virtual void	send (const uint8_t in[], size_t length)
void	send (std::span< const uint8_t > in)
void	send (std::span< const uint8_t > in, size_t length)
void	send (uint8_t in)

Detailed Description

This class represents a data sink which writes its output to a stream.

Definition at line 35 of file data_snk.h.

Constructor & Destructor Documentation

DataSink_Stream()

Botan::DataSink_Stream::DataSink_Stream	(	std::ostream &	stream,
		std::string_view	name = "<std::ostream>" )

Construct a DataSink_Stream from a stream.

Parameters

stream	the stream to write to
name	identifier

Definition at line 43 of file data_snk.cpp.

: m_identifier(name), m_sink(out) {}

References name().

~DataSink_Stream()

Botan::DataSink_Stream::~DataSink_Stream ( )

overridedefault

Member Function Documentation

attachable()

bool Botan::DataSink::attachable ( )

inlineoverridevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 23 of file data_snk.h.

{ return false; }

end_msg()

void Botan::DataSink_Stream::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 36 of file data_snk.cpp.

                              {
   m_sink.flush();
}

name()

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 55 of file data_snk.h.

{ return m_identifier; }

Referenced by DataSink_Stream().

send() [1/4]

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 33 of file filter.cpp.

                                                      {
   if(!length) {
      return;
   }
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j) {
      if(m_next[j]) {
         if(!m_write_queue.empty()) {
            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();
   }
}

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), operator=(), send(), Botan::Base64_Decoder::write(), Botan::Chain::write(), Botan::Fork::write(), and Botan::Hex_Decoder::write().

send() [2/4]

void Botan::Filter::send ( std::span< const uint8_t > in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 76 of file filter.h.

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

References send().

Referenced by send().

send() [3/4]

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

protectedinherited

Parameters

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

This previously took a std::vector, for which the length field (allowing using just a prefix of the vector) somewhat made sense. It makes less sense now that we are using a span here; you can just use first to get a prefix.

Definition at line 25 of file filter.cpp.

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

References BOTAN_ASSERT_NOMSG, and send().

send() [4/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 71 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

start_msg()

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 */
      }

write()

void Botan::DataSink_Stream::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 26 of file data_snk.cpp.

                                                              {
   m_sink.write(cast_uint8_ptr_to_char(out), length);
   if(!m_sink.good()) {
      throw Stream_IO_Error("DataSink_Stream: Failure writing to " + m_identifier);
   }
}

References Botan::cast_uint8_ptr_to_char().

---

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

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