Botan::DataSource Class Reference

#include <data_src.h>

Inheritance diagram for Botan::DataSource:

Public Member Functions
virtual bool	check_available (size_t n)=0
	DataSource ()=default
	DataSource (const DataSource &)=delete
	DataSource (DataSource &&)=default
size_t	discard_next (size_t N)
virtual bool	end_of_data () const =0
virtual size_t	get_bytes_read () const =0
virtual std::string	id () const
DataSource &	operator= (const DataSource &)=delete
DataSource &	operator= (DataSource &&)=default
virtual size_t	peek (uint8_t out[], size_t length, size_t peek_offset) const =0
size_t	peek_byte (uint8_t &out) const
virtual size_t	read (uint8_t out[], size_t length)=0
std::optional< uint8_t >	read_byte ()
size_t	read_byte (uint8_t &out)
virtual	~DataSource ()=default

Detailed Description

This class represents an abstract data source object.

Definition at line 25 of file data_src.h.

Constructor & Destructor Documentation

DataSource() [1/3]

Botan::DataSource::DataSource ( )

default

Referenced by DataSource(), DataSource(), operator=(), operator=(), Botan::Pipe::process_msg(), and Botan::Pipe::write().

~DataSource()

virtual Botan::DataSource::~DataSource ( )

virtualdefault

DataSource() [2/3]

Botan::DataSource::DataSource ( const DataSource & )

delete

References DataSource().

DataSource() [3/3]

Botan::DataSource::DataSource ( DataSource && )

default

References DataSource().

Member Function Documentation

check_available()

virtual bool Botan::DataSource::check_available ( size_t n )

pure virtual

Implemented in Botan::DataSource_Memory, Botan::DataSource_Stream, Botan::Pipe, and Botan::SecureQueue.

discard_next()

size_t Botan::DataSource::discard_next

(

size_t

N

)

Discard the next N bytes of the data

Parameters

N	the number of bytes to discard

Returns

number of bytes actually discarded

Definition at line 53 of file data_src.cpp.

                                        {
   uint8_t buf[64] = {0};
   size_t discarded = 0;
 
   while(n > 0) {
      const size_t got = this->read(buf, std::min(n, sizeof(buf)));
      discarded += got;
      n -= got;
 
      if(got == 0) {
         break;
      }
   }
 
   return discarded;
}

References read().

end_of_data()

virtual bool Botan::DataSource::end_of_data ( ) const

pure virtual

Test whether the source still has data that can be read.

Returns

true if there is no more data to read, false otherwise

Implemented in Botan::DataSource_Memory, Botan::DataSource_Stream, Botan::Pipe, and Botan::SecureQueue.

Referenced by Botan::Pipe::write().

get_bytes_read()

virtual size_t Botan::DataSource::get_bytes_read ( ) const

pure virtual

Returns

number of bytes read so far.

Implemented in Botan::DataSource_Memory, Botan::DataSource_Stream, Botan::Pipe, and Botan::SecureQueue.

id()

virtual std::string Botan::DataSource::id ( ) const

inlinevirtual

return the id of this data source

Returns

std::string representing the id of this data source

Reimplemented in Botan::DataSource_Stream.

Definition at line 63 of file data_src.h.

{ return ""; }

operator=() [1/2]

DataSource & Botan::DataSource::operator= ( const DataSource & )

delete

References DataSource().

operator=() [2/2]

DataSource & Botan::DataSource::operator= ( DataSource && )

default

References DataSource().

peek()

virtual size_t Botan::DataSource::peek ( uint8_t out[], size_t length, size_t peek_offset ) const

nodiscardpure virtual

Read from the source but do not modify the internal offset. Consecutive calls to peek() will return portions of the source starting at the same position.

Parameters

out	the byte array to write the output to
length	the length of the byte array out
peek_offset	the offset into the stream to read at

Returns

length in bytes that was actually read and put into out

Implemented in Botan::DataSource_Memory, Botan::DataSource_Stream, Botan::Pipe, and Botan::SecureQueue.

Referenced by Botan::PEM_Code::matches(), and peek_byte().

peek_byte()

size_t Botan::DataSource::peek_byte

(

uint8_t &

out

)

const

Peek at one byte.

Parameters

out	an output byte

Returns

length in bytes that was actually read and put into out

Definition at line 46 of file data_src.cpp.

                                               {
   return peek(&out, 1, 0);
}

References peek().

Referenced by Botan::ASN1::maybe_BER().

read()

virtual size_t Botan::DataSource::read ( uint8_t out[], size_t length )

nodiscardpure virtual

Read from the source. Moves the internal offset so that every call to read will return a new portion of the source.

Parameters

out	the byte array to write the result to
length	the length of the byte array out

Returns

length in bytes that was actually read and put into out

Implemented in Botan::DataSource_Memory, Botan::DataSource_Stream, Botan::Pipe, and Botan::SecureQueue.

Referenced by discard_next(), read_byte(), read_byte(), and Botan::Pipe::write().

read_byte() [1/2]

std::optional< uint8_t > Botan::DataSource::read_byte

(

)

Read one byte.

Returns nullopt if no further bytes are available

Definition at line 34 of file data_src.cpp.

                                           {
   uint8_t b = 0;
   if(this->read(&b, 1) == 1) {
      return b;
   } else {
      return {};
   }
}

References read().

read_byte() [2/2]

size_t Botan::DataSource::read_byte

(

uint8_t &

out

)

Read one byte.

Parameters

out	the byte to read to

Returns

length in bytes that was actually read and put into out

Definition at line 27 of file data_src.cpp.

                                         {
   return read(&out, 1);
}

References read().

Referenced by Botan::PEM_Code::decode(), and Botan::ASN1::maybe_BER().

---

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

• src/lib/utils/data_src.h
• src/lib/utils/data_src.cpp