Abstraction of AdditionalDescription. More...

#include <additional-description.hpp>

Classes
class	Error

Public Types
typedef std::map< std::string, std::string >::iterator	iterator

typedef std::map< std::string, std::string >::const_iterator	const_iterator

Public Member Functions
	AdditionalDescription ()=default
	Create an empty AdditionalDescription. More...

	AdditionalDescription (const Block &block)
	Create AdditionalDescription from `block`. More...

const std::string &	get (const std::string &key) const

void	set (const std::string &key, const std::string &value)

bool	has (const std::string &key) const

size_t	size () const

bool	empty () const

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Fast encoding or block size estimation. More...

const Block &	wireEncode () const
	Encode ValidityPeriod into TLV block. More...

void	wireDecode (const Block &wire)
	Decode ValidityPeriod from TLV block. More...

Friends
bool	operator== (const AdditionalDescription &lhs, const AdditionalDescription &rhs)

bool	operator!= (const AdditionalDescription &lhs, const AdditionalDescription &rhs)

Detailed Description

Abstraction of AdditionalDescription.

See also: docs/specs/certificate-format.rst

Definition at line 39 of file additional-description.hpp.

Member Typedef Documentation

◆ iterator

typedef std::map<std::string, std::string>::iterator ndn::security::v2::AdditionalDescription::iterator

Definition at line 48 of file additional-description.hpp.

◆ const_iterator

typedef std::map<std::string, std::string>::const_iterator ndn::security::v2::AdditionalDescription::const_iterator

Definition at line 49 of file additional-description.hpp.

Constructor & Destructor Documentation

◆ AdditionalDescription() [1/2]

ndn::security::v2::AdditionalDescription::AdditionalDescription ( )

default

Create an empty AdditionalDescription.

◆ AdditionalDescription() [2/2]

ndn::security::v2::AdditionalDescription::AdditionalDescription ( const Block & block )

explicit

Create AdditionalDescription from block.

Definition at line 41 of file additional-description.cpp.

References wireDecode().

Member Function Documentation

◆ get()

const std::string & ndn::security::v2::AdditionalDescription::get ( const std::string & key ) const

Definition at line 47 of file additional-description.cpp.

References NDN_THROW.

◆ set()

void ndn::security::v2::AdditionalDescription::set	(	const std::string &	key,
		const std::string &	value
	)

Definition at line 57 of file additional-description.cpp.

◆ has()

bool ndn::security::v2::AdditionalDescription::has ( const std::string & key ) const

Definition at line 63 of file additional-description.cpp.

◆ size()

size_t ndn::security::v2::AdditionalDescription::size ( ) const

inline

Definition at line 73 of file additional-description.hpp.

◆ empty()

bool ndn::security::v2::AdditionalDescription::empty ( ) const

inline

Definition at line 79 of file additional-description.hpp.

◆ begin() [1/2]

AdditionalDescription::iterator ndn::security::v2::AdditionalDescription::begin ( )

Definition at line 69 of file additional-description.cpp.

◆ end() [1/2]

AdditionalDescription::iterator ndn::security::v2::AdditionalDescription::end ( )

Definition at line 75 of file additional-description.cpp.

◆ begin() [2/2]

AdditionalDescription::const_iterator ndn::security::v2::AdditionalDescription::begin ( ) const

Definition at line 81 of file additional-description.cpp.

◆ end() [2/2]

AdditionalDescription::const_iterator ndn::security::v2::AdditionalDescription::end ( ) const

Definition at line 87 of file additional-description.cpp.

◆ wireEncode() [1/2]

template<encoding::Tag TAG>

size_t ndn::security::v2::AdditionalDescription::wireEncode ( EncodingImpl< TAG > & encoder ) const

Fast encoding or block size estimation.

Definition at line 94 of file additional-description.cpp.

References ndn::tlv::AdditionalDescription, ndn::tlv::DescriptionEntry, ndn::tlv::DescriptionKey, ndn::tlv::DescriptionValue, and ndn::encoding::prependStringBlock().

◆ wireEncode() [2/2]

const Block & ndn::security::v2::AdditionalDescription::wireEncode ( ) const

Encode ValidityPeriod into TLV block.

Definition at line 116 of file additional-description.cpp.

References ndn::Block::hasWire(), and ndn::Block::parse().

◆ wireDecode()

void ndn::security::v2::AdditionalDescription::wireDecode ( const Block & wire )

Decode ValidityPeriod from TLV block.

Exceptions

Error when an invalid TLV block supplied

Definition at line 134 of file additional-description.cpp.

References ndn::tlv::AdditionalDescription, ndn::tlv::DescriptionEntry, ndn::tlv::DescriptionKey, ndn::tlv::DescriptionValue, ndn::Block::elements(), ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::Block::elements_size(), ndn::Block::hasWire(), ndn::security::v2::KEY_OFFSET, NDN_THROW, ndn::Block::parse(), ndn::encoding::readString(), ndn::Block::type(), and ndn::security::v2::VALUE_OFFSET.

Referenced by AdditionalDescription().

Friends And Related Function Documentation

◆ operator==

bool operator==	(	const AdditionalDescription &	lhs,
		const AdditionalDescription &	rhs
	)

friend

Definition at line 118 of file additional-description.hpp.

◆ operator!=

bool operator!=	(	const AdditionalDescription &	lhs,
		const AdditionalDescription &	rhs
	)