Represents an absolute name. More...

#include <ndn-cxx/name.hpp>

Public Types
using	allocator_type = void

using	Component = name::Component

using	component_container = std::vector< Component >

using	const_iterator = const Component *

using	const_pointer = const Component *

using	const_reference = const Component &

using	const_reverse_iterator = std::reverse_iterator< const_iterator >

using	difference_type = component_container::difference_type

using	Error = name::Component::Error

using	iterator = const Component *

using	pointer = Component *

using	reference = Component &

using	reverse_iterator = std::reverse_iterator< iterator >

using	size_type = component_container::size_type

using	value_type = Component

Public Member Functions
	Name ()
	Create an empty name. More...

	Name (const Block &wire)
	Decode Name from wire encoding. More...

	Name (const char *uri)
	Parse name from NDN URI. More...

	Name (std::string uri)
	Create name from NDN URI. More...

Name &	append (Component &&component)
	Append a name component. More...

Name &	append (const char *str)
	Append a `GenericNameComponent`, copying TLV-VALUE from a null-terminated string. More...

Name &	append (const Component &component)
	Append a name component. More...

Name &	append (const PartialName &name)
	Append a PartialName. More...

Name &	append (const uint8_t *value, size_t count)
	Append a `GenericNameComponent`, copying `count` bytes at `value` as TLV-VALUE. More...

template<class Iterator >
Name &	append (Iterator first, Iterator last)
	Append a `GenericNameComponent`, copying TLV-VALUE from a range. More...

Name &	append (span< const uint8_t > value)
	Append a `GenericNameComponent`, copying the TLV-VALUE from `value`. More...

Name &	append (uint32_t type, const uint8_t *value, size_t count)
	Append a `NameComponent` of TLV-TYPE `type`, copying `count` bytes at `value` as TLV-VALUE. More...

template<class Iterator >
Name &	append (uint32_t type, Iterator first, Iterator last)
	Append a `NameComponent` of TLV-TYPE `type`, copying TLV-VALUE from a range. More...

Name &	append (uint32_t type, span< const uint8_t > value)
	Append a `NameComponent` of TLV-TYPE `type`, copying the TLV-VALUE from `value`. More...

Name &	appendByteOffset (uint64_t offset)
	Append a byte offset component. More...

Name &	appendImplicitSha256Digest (ConstBufferPtr digest)
	Append an `ImplicitSha256Digest` component. More...

Name &	appendImplicitSha256Digest (span< const uint8_t > digestBytes)
	Append an `ImplicitSha256Digest` component. More...

Name &	appendKeyword (const char *keyword)
	Append a keyword component. More...

Name &	appendKeyword (span< const uint8_t > keyword)
	Append a keyword component. More...

Name &	appendNumber (uint64_t number)
	Append a component with a NonNegativeInteger. More...

Name &	appendNumberWithMarker (uint8_t marker, uint64_t number)
	Append a component with a marked number. More...

Name &	appendParametersSha256Digest (ConstBufferPtr digest)
	Append a `ParametersSha256Digest` component. More...

Name &	appendParametersSha256Digest (span< const uint8_t > digestBytes)
	Append a `ParametersSha256Digest` component. More...

Name &	appendParametersSha256DigestPlaceholder ()
	Append a placeholder for a `ParametersSha256Digest` component. More...

Name &	appendSegment (uint64_t segmentNo)
	Append a segment number (sequential) component. More...

Name &	appendSequenceNumber (uint64_t seqNo)
	Append a sequence number component. More...

Name &	appendTimestamp (const optional< time::system_clock::time_point > &timestamp=nullopt)
	Append a timestamp component. More...

Name &	appendVersion (const optional< uint64_t > &version=nullopt)
	Append a version component. More...

const Component &	at (ssize_t i) const
	Returns an immutable reference to the component at the specified index, with bounds checking. More...

const_iterator	begin () const noexcept
	Begin iterator. More...

void	clear ()
	Remove all components. More...

int	compare (const Name &other) const
	Compare this to the other Name using NDN canonical ordering. More...

int	compare (size_t pos1, size_t count1, const Name &other, size_t pos2=0, size_t count2=npos) const
	Compares `[pos1, pos1+count1)` components in this Name to `[pos2, pos2+count2)` components in `other`. More...

Name	deepCopy () const
	Make a deep copy of the name, reallocating the underlying memory buffer. More...

bool	empty () const noexcept
	Checks if the name is empty, i.e., has no components. More...

const_iterator	end () const noexcept
	End iterator. More...

bool	equals (const Name &other) const noexcept
	Check if this name equals another name. More...

void	erase (ssize_t i)
	Erase the component at the specified index. More...

const Component &	get (ssize_t i) const noexcept
	Returns an immutable reference to the component at the specified index. More...

PartialName	getPrefix (ssize_t nComponents) const
	Returns a prefix of the name. More...

PartialName	getSubName (ssize_t iStartComponent, size_t nComponents=npos) const
	Extracts some components as a sub-name (PartialName). More...

Name	getSuccessor () const
	Get the successor of a name. More...

bool	hasWire () const noexcept
	Check if this instance already has wire encoding. More...

bool	isPrefixOf (const Name &other) const noexcept
	Check if this name is a prefix of another name. More...

const Component &	operator[] (ssize_t i) const noexcept
	Equivalent to get(). More...

template<class T >
void	push_back (const T &component)
	Append a name component. More...

const_reverse_iterator	rbegin () const noexcept
	Reverse begin iterator. More...

const_reverse_iterator	rend () const noexcept
	Reverse end iterator. More...

Name &	set (ssize_t i, Component &&component)
	Replace the component at the specified index. More...

Name &	set (ssize_t i, const Component &component)
	Replace the component at the specified index. More...

size_t	size () const noexcept
	Returns the number of components. More...

std::string	toUri (name::UriFormat format=name::UriFormat::DEFAULT) const
	Get URI representation of the name. More...

void	toUri (std::ostream &os, name::UriFormat format=name::UriFormat::DEFAULT) const
	Write URI representation of the name to the output stream. More...

void	wireDecode (const Block &wire)
	Decode name from wire encoding. More...

const Block &	wireEncode () const
	Perform wire encoding, or return existing wire encoding. More...

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

Static Public Attributes
static const size_t	npos = std::numeric_limits<size_t>::max()
	Indicates "until the end" in getSubName() and compare(). More...

Friends
bool	operator!= (const Name &lhs, const Name &rhs) noexcept

bool	operator< (const Name &lhs, const Name &rhs)

std::ostream &	operator<< (std::ostream &os, const Name &name)
	Print the URI representation of a name. More...

bool	operator<= (const Name &lhs, const Name &rhs)

bool	operator== (const Name &lhs, const Name &rhs) noexcept

bool	operator> (const Name &lhs, const Name &rhs)

bool	operator>= (const Name &lhs, const Name &rhs)

Detailed Description

Represents an absolute name.

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html

Definition at line 43 of file name.hpp.

Member Typedef Documentation

◆ allocator_type

using ndn::Name::allocator_type = void

Definition at line 53 of file name.hpp.

◆ Component

using ndn::Name::Component = name::Component

Definition at line 48 of file name.hpp.

◆ component_container

using ndn::Name::component_container = std::vector<Component>

Definition at line 49 of file name.hpp.

◆ const_iterator

using ndn::Name::const_iterator = const Component*

Definition at line 59 of file name.hpp.

◆ const_pointer

using ndn::Name::const_pointer = const Component*

Definition at line 57 of file name.hpp.

◆ const_reference

using ndn::Name::const_reference = const Component&

Definition at line 55 of file name.hpp.

◆ const_reverse_iterator

using ndn::Name::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 61 of file name.hpp.

◆ difference_type

using ndn::Name::difference_type = component_container::difference_type

Definition at line 62 of file name.hpp.

◆ Error

using ndn::Name::Error = name::Component::Error

Definition at line 46 of file name.hpp.

◆ iterator

using ndn::Name::iterator = const Component*

Definition at line 58 of file name.hpp.

◆ pointer

using ndn::Name::pointer = Component*

Definition at line 56 of file name.hpp.

◆ reference

using ndn::Name::reference = Component&

Definition at line 54 of file name.hpp.

◆ reverse_iterator

using ndn::Name::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 60 of file name.hpp.

◆ size_type

using ndn::Name::size_type = component_container::size_type

Definition at line 63 of file name.hpp.

◆ value_type

using ndn::Name::value_type = Component

Definition at line 52 of file name.hpp.

Constructor & Destructor Documentation

◆ Name() [1/4]

ndn::Name::Name ( )

Create an empty name.

Postcondition: empty() == true

Definition at line 54 of file name.cpp.

◆ Name() [2/4]

ndn::Name::Name ( const Block & wire )

explicit

Decode Name from wire encoding.

Exceptions

tlv::Error wire encoding is invalid

This is a more efficient equivalent for

Name name;

name.wireDecode(wire);

ndn::Name::Name

Name()

Create an empty name.

Definition: name.cpp:54

Definition at line 59 of file name.cpp.

◆ Name() [3/4]

ndn::Name::Name ( const char * uri )

Parse name from NDN URI.

Parameters

uri	a null-terminated URI string

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html#ndn-uri-scheme

Definition at line 65 of file name.cpp.

◆ Name() [4/4]

ndn::Name::Name ( std::string uri )

Create name from NDN URI.

Parameters

uri	a URI string

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html#ndn-uri-scheme

Definition at line 70 of file name.cpp.

Member Function Documentation

◆ append() [1/10]

Name& ndn::Name::append ( Component && component )

inline

Append a name component.

Returns: A reference to this Name, to allow chaining.

Definition at line 294 of file name.hpp.

◆ append() [2/10]

Name& ndn::Name::append ( const char * str )

inline

Append a GenericNameComponent, copying TLV-VALUE from a null-terminated string.

Parameters

str	a null-terminated string. Bytes from the string are copied as is, and not interpreted as URI component.

Returns: A reference to this Name, to allow chaining.

Definition at line 379 of file name.hpp.

◆ append() [3/10]

Name& ndn::Name::append ( const Component & component )

inline

Append a name component.

Returns: A reference to this Name, to allow chaining.

Definition at line 283 of file name.hpp.

◆ append() [4/10]

Name & ndn::Name::append ( const PartialName & name )

Append a PartialName.

Parameters

name	the components to append

Returns: A reference to this Name, to allow chaining.

Definition at line 242 of file name.cpp.

◆ append() [5/10]

Name& ndn::Name::append	(	const uint8_t *	value,
		size_t	count
	)

inline

Append a GenericNameComponent, copying count bytes at value as TLV-VALUE.

Returns: A reference to this Name, to allow chaining.

Deprecated:: Use append(span<const uint8_t>)

Definition at line 339 of file name.hpp.

◆ append() [6/10]

template<class Iterator >

Name& ndn::Name::append	(	Iterator	first,
		Iterator	last
	)

inline

Append a GenericNameComponent, copying TLV-VALUE from a range.

Template Parameters

Iterator an InputIterator dereferencing to a one-octet value type. More efficient implementation is available when it is a RandomAccessIterator.

Parameters

first	beginning of the range.
last	past-end of the range.

Returns: A reference to this Name, to allow chaining.

Definition at line 368 of file name.hpp.

◆ append() [7/10]

Name& ndn::Name::append ( span< const uint8_t > value )

inline

Append a GenericNameComponent, copying the TLV-VALUE from value.

Returns: A reference to this Name, to allow chaining.

Definition at line 315 of file name.hpp.

◆ append() [8/10]

Name& ndn::Name::append	(	uint32_t	type,
		const uint8_t *	value,
		size_t	count
	)

inline

Append a NameComponent of TLV-TYPE type, copying count bytes at value as TLV-VALUE.

Returns: A reference to this Name, to allow chaining.

Deprecated:: Use append(uint32_t, span<const uint8_t>)

Definition at line 327 of file name.hpp.

◆ append() [9/10]

template<class Iterator >

Name& ndn::Name::append	(	uint32_t	type,
		Iterator	first,
		Iterator	last
	)

inline

Append a NameComponent of TLV-TYPE type, copying TLV-VALUE from a range.

Template Parameters

Iterator an InputIterator dereferencing to a one-octet value type. More efficient implementation is available when it is a RandomAccessIterator.

Parameters

type	the TLV-TYPE.
first	beginning of the range.
last	past-end of the range.

Returns: A reference to this Name, to allow chaining.

Definition at line 354 of file name.hpp.

◆ append() [10/10]

Name& ndn::Name::append	(	uint32_t	type,
		span< const uint8_t >	value
	)

inline

Append a NameComponent of TLV-TYPE type, copying the TLV-VALUE from value.

Returns: A reference to this Name, to allow chaining.

Definition at line 305 of file name.hpp.

◆ appendByteOffset()

Name& ndn::Name::appendByteOffset ( uint64_t offset )

inline

Append a byte offset component.

Returns: A reference to this Name, to allow chaining.

See also: NDN Naming Conventions https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/

Definition at line 436 of file name.hpp.

◆ appendImplicitSha256Digest() [1/2]

Name& ndn::Name::appendImplicitSha256Digest ( ConstBufferPtr digest )

inline

Append an ImplicitSha256Digest component.

Returns: A reference to this Name, to allow chaining.

Definition at line 479 of file name.hpp.

◆ appendImplicitSha256Digest() [2/2]

Name& ndn::Name::appendImplicitSha256Digest ( span< const uint8_t > digestBytes )

inline

Append an ImplicitSha256Digest component.

Returns: A reference to this Name, to allow chaining.

Definition at line 489 of file name.hpp.

◆ appendKeyword() [1/2]

Name& ndn::Name::appendKeyword ( const char * keyword )

inline

Append a keyword component.

Returns: A reference to this Name, to allow chaining.

Definition at line 536 of file name.hpp.

◆ appendKeyword() [2/2]

Name& ndn::Name::appendKeyword ( span< const uint8_t > keyword )

inline

Append a keyword component.

Returns: A reference to this Name, to allow chaining.

Definition at line 526 of file name.hpp.

◆ appendNumber()

Name& ndn::Name::appendNumber ( uint64_t number )

inline

Append a component with a NonNegativeInteger.

Returns: A reference to this Name, to allow chaining.

See also: https://named-data.net/doc/NDN-packet-spec/0.3/tlv.html#non-negative-integer-encoding

Definition at line 396 of file name.hpp.

◆ appendNumberWithMarker()

Name& ndn::Name::appendNumberWithMarker	(	uint8_t	marker,
		uint64_t	number
	)

inline

Append a component with a marked number.

Parameters

marker	1-octet marker
number	the number

The component is encoded as a 1-octet marker, followed by a NonNegativeInteger.

Returns: A reference to this Name, to allow chaining.

See also: NDN Naming Conventions revision 1 (obsolete) https://named-data.net/wp-content/uploads/2014/08/ndn-tr-22-ndn-memo-naming-conventions.pdf

Definition at line 412 of file name.hpp.

◆ appendParametersSha256Digest() [1/2]

Name& ndn::Name::appendParametersSha256Digest ( ConstBufferPtr digest )

inline

Append a ParametersSha256Digest component.

Returns: A reference to this Name, to allow chaining.

Definition at line 499 of file name.hpp.

◆ appendParametersSha256Digest() [2/2]

Name& ndn::Name::appendParametersSha256Digest ( span< const uint8_t > digestBytes )

inline

Append a ParametersSha256Digest component.

Returns: A reference to this Name, to allow chaining.

Definition at line 509 of file name.hpp.

◆ appendParametersSha256DigestPlaceholder()

Name & ndn::Name::appendParametersSha256DigestPlaceholder ( )

Append a placeholder for a ParametersSha256Digest component.

Returns: A reference to this Name, to allow chaining.

Definition at line 263 of file name.cpp.

◆ appendSegment()

Name& ndn::Name::appendSegment ( uint64_t segmentNo )

inline

Append a segment number (sequential) component.

Returns: A reference to this Name, to allow chaining.

See also: NDN Naming Conventions https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/

Definition at line 424 of file name.hpp.

◆ appendSequenceNumber()

Name& ndn::Name::appendSequenceNumber ( uint64_t seqNo )

inline

Append a sequence number component.

Returns: A reference to this Name, to allow chaining.

See also: NDN Naming Conventions https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/

Definition at line 469 of file name.hpp.

◆ appendTimestamp()

Name & ndn::Name::appendTimestamp ( const optional< time::system_clock::time_point > & timestamp = nullopt )

Append a timestamp component.

Parameters

timestamp the timestamp to append; if nullopt, the current system time is used

Returns: A reference to this Name, to allow chaining.

See also: NDN Naming Conventions https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/

Definition at line 236 of file name.cpp.

◆ appendVersion()

Name & ndn::Name::appendVersion ( const optional< uint64_t > & version = nullopt )

Append a version component.

Parameters

version the version number to append; if nullopt, the current UNIX time in milliseconds is used

Returns: A reference to this Name, to allow chaining.

See also: NDN Naming Conventions https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/

Definition at line 230 of file name.cpp.

◆ at()

const name::Component & ndn::Name::at ( ssize_t i ) const

Returns an immutable reference to the component at the specified index, with bounds checking.

Parameters

i	zero-based index of the component to return; if negative, it is interpreted as offset from the end of the name

Exceptions

Error The index is out of bounds.

Definition at line 171 of file name.cpp.

◆ begin()

const_iterator ndn::Name::begin ( ) const

inlinenoexcept

Begin iterator.

Definition at line 228 of file name.hpp.

◆ clear()

void ndn::Name::clear ( )

Remove all components.

Postcondition: empty() == true

Definition at line 281 of file name.cpp.

◆ compare() [1/2]

int ndn::Name::compare ( const Name & other ) const

inline

Compare this to the other Name using NDN canonical ordering.

If the first components of each name are not equal, this returns a negative value if the first comes before the second using the NDN canonical ordering for name components, or a positive value if it comes after. If they are equal, this compares the second components of each name, etc. If both names are the same up to the size of the shorter name, this returns a negative value if the first name is shorter than the second or a positive value if it is longer. For example, if you std::sort gives: /a/b/d /a/b/cc /c /c/a /bb . This is intuitive because all names with the prefix /a are next to each other. But it may be also be counter-intuitive because /c comes before /bb according to NDN canonical ordering since it is shorter.

Parameters

other The other Name to compare with.

Return values

negative	this comes before other in canonical ordering
zero	this equals other
positive	this comes after other in canonical ordering

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html#canonical-order

Definition at line 638 of file name.hpp.

◆ compare() [2/2]

int ndn::Name::compare	(	size_t	pos1,
		size_t	count1,
		const Name &	other,
		size_t	pos2 = `0`,
		size_t	count2 = `npos`
	)		const

Compares [pos1, pos1+count1) components in this Name to [pos2, pos2+count2) components in other.

Equivalent to getSubName(pos1, count1).compare(other.getSubName(pos2, count2)).

Definition at line 330 of file name.cpp.

◆ deepCopy()

Name ndn::Name::deepCopy ( ) const

Make a deep copy of the name, reallocating the underlying memory buffer.

Definition at line 160 of file name.cpp.

◆ empty()

bool ndn::Name::empty ( ) const

inlinenoexcept

Checks if the name is empty, i.e., has no components.

Definition at line 146 of file name.hpp.

◆ end()

const_iterator ndn::Name::end ( ) const

inlinenoexcept

End iterator.

Definition at line 236 of file name.hpp.

◆ equals()

bool ndn::Name::equals ( const Name & other ) const

noexcept

Check if this name equals another name.

Two names are equal if they have the same number of components, and components at each index are equal.

Definition at line 316 of file name.cpp.

◆ erase()

void ndn::Name::erase ( ssize_t i )

Erase the component at the specified index.

Parameters

i	zero-based index of the component to erase; if negative, it is interpreted as offset from the end of the name

Warning: No bounds checking is performed, using an out-of-range index is undefined behavior.

Definition at line 270 of file name.cpp.

◆ get()

const Component& ndn::Name::get ( ssize_t i ) const

inlinenoexcept

Returns an immutable reference to the component at the specified index.

Parameters

i	zero-based index of the component to return; if negative, it is interpreted as offset from the end of the name

Warning: No bounds checking is performed, using an out-of-range index is undefined behavior.

Definition at line 167 of file name.hpp.

◆ getPrefix()

PartialName ndn::Name::getPrefix ( ssize_t nComponents ) const

inline

Returns a prefix of the name.

Parameters

nComponents number of components; if negative, size()+nComponents is used instead

Returns a new PartialName containing a prefix of this name up to size() - nComponents. For example, getPrefix(-1) returns the name without the final component.

Definition at line 216 of file name.hpp.

◆ getSubName()

PartialName ndn::Name::getSubName	(	ssize_t	iStartComponent,
		size_t	nComponents = `npos`
	)		const

Extracts some components as a sub-name (PartialName).

Parameters

iStartComponent	zero-based index of the first component; if negative, size()+iStartComponent is used instead
nComponents	number of desired components, starting at `iStartComponent`; use npos to return all components until the end of the name

Returns: a new PartialName containing the extracted components

If iStartComponent is positive and indexes out of bounds, returns an empty PartialName. If iStartComponent is negative and indexes out of bounds, the sub-name will start from the beginning of the name instead. If nComponents is out of bounds, returns all components until the end of the name.

Definition at line 185 of file name.cpp.

◆ getSuccessor()

Name ndn::Name::getSuccessor ( ) const

Get the successor of a name.

The successor of a name is defined as follows:

N represents the set of NDN Names, and X,Y ∈ N.
Operator < is defined by canonical order on N.
Y is the successor of X, if (a) X < Y, and (b) ∄ Z ∈ N s.t. X < Z < Y.

In plain words, successor of a name is the same name, but with its last component advanced to a next possible value.

Examples:

successor of / is /sha256digest=0000000000000000000000000000000000000000000000000000000000000000.
successor of /sha256digest=0000000000000000000000000000000000000000000000000000000000000000 is /sha256digest=0000000000000000000000000000000000000000000000000000000000000001.
successor of /sha256digest=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff is /2=....
successor of /P/A is /P/B.
successor of /Q/FF is /Q/%00%00.

Returns: a new Name containing the successor

Definition at line 289 of file name.cpp.

◆ hasWire()

bool ndn::Name::hasWire ( ) const

inlinenoexcept

Check if this instance already has wire encoding.

Definition at line 112 of file name.hpp.

◆ isPrefixOf()

bool ndn::Name::isPrefixOf ( const Name & other ) const

noexcept

Check if this name is a prefix of another name.

This name is a prefix of other if the N components of this name are same as the first N components of other.

Return values

true	this name is a prefix of `other`
false	this name is not a prefix of `other`

Definition at line 300 of file name.cpp.

◆ operator[]()

const Component& ndn::Name::operator[] ( ssize_t i ) const

inlinenoexcept

Equivalent to get().

Definition at line 179 of file name.hpp.

◆ push_back()

template<class T >

void ndn::Name::push_back ( const T & component )

inline

Append a name component.

Note: This makes push_back() an alias of append(), giving Name a similar API as std::vector.

Definition at line 548 of file name.hpp.

◆ rbegin()

const_reverse_iterator ndn::Name::rbegin ( ) const

inlinenoexcept

Reverse begin iterator.

Definition at line 244 of file name.hpp.

◆ rend()

const_reverse_iterator ndn::Name::rend ( ) const

inlinenoexcept

Reverse end iterator.

Definition at line 252 of file name.hpp.

◆ set() [1/2]

Name & ndn::Name::set	(	ssize_t	i,
		Component &&	component
	)

Replace the component at the specified index.

Parameters

i	zero-based index of the component to replace; if negative, it is interpreted as offset from the end of the name
component	the new component to use as a replacement

Returns: A reference to this Name, to allow chaining.

Warning: No bounds checking is performed, using an out-of-range index is undefined behavior.

Definition at line 218 of file name.cpp.

◆ set() [2/2]

Name & ndn::Name::set	(	ssize_t	i,
		const Component &	component
	)

Replace the component at the specified index.

Parameters

i	zero-based index of the component to replace; if negative, it is interpreted as offset from the end of the name
component	the new component to use as a replacement

Returns: A reference to this Name, to allow chaining.

Warning: No bounds checking is performed, using an out-of-range index is undefined behavior.

Definition at line 206 of file name.cpp.

◆ size()

size_t ndn::Name::size ( ) const

inlinenoexcept

Returns the number of components.

Definition at line 155 of file name.hpp.

◆ toUri() [1/2]

std::string ndn::Name::toUri ( name::UriFormat format = name::UriFormat::DEFAULT ) const

Get URI representation of the name.

Returns: URI representation; the "ndn:" scheme identifier is not included

Note: To print URI representation into a stream, it is more efficient to use os << name.

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html#ndn-uri-scheme

Definition at line 363 of file name.cpp.

◆ toUri() [2/2]

void ndn::Name::toUri	(	std::ostream &	os,
		name::UriFormat	format = `name::UriFormat::DEFAULT`
	)		const

Write URI representation of the name to the output stream.

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html#ndn-uri-scheme

Definition at line 349 of file name.cpp.

◆ wireDecode()

void ndn::Name::wireDecode ( const Block & wire )

Decode name from wire encoding.

Exceptions

tlv::Error wire encoding is invalid

Postcondition: hasWire() == true

Definition at line 150 of file name.cpp.

◆ wireEncode() [1/2]

const Block & ndn::Name::wireEncode ( ) const

Perform wire encoding, or return existing wire encoding.

Postcondition: hasWire() == true

Definition at line 132 of file name.cpp.

◆ wireEncode() [2/2]

template<encoding::Tag TAG>

size_t ndn::Name::wireEncode ( EncodingImpl< TAG > & encoder ) const

Fast encoding or block size estimation.

Definition at line 117 of file name.cpp.

Friends And Related Function Documentation

◆ operator!=

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

friend

Definition at line 663 of file name.hpp.

◆ operator<

bool operator<	(	const Name &	lhs,
		const Name &	rhs
	)

friend

Definition at line 668 of file name.hpp.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const Name &	name
	)

friend

Print the URI representation of a name.

See also: https://named-data.net/doc/NDN-packet-spec/0.3/name.html#ndn-uri-scheme

Definition at line 696 of file name.hpp.

◆ operator<=

bool operator<=	(	const Name &	lhs,
		const Name &	rhs
	)

friend

Definition at line 674 of file name.hpp.

◆ operator==

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

friend

Definition at line 657 of file name.hpp.

◆ operator>

bool operator>	(	const Name &	lhs,
		const Name &	rhs
	)

friend

Definition at line 681 of file name.hpp.

◆ operator>=

bool operator>=	(	const Name &	lhs,
		const Name &	rhs
	)

friend

Definition at line 687 of file name.hpp.

Member Data Documentation

◆ npos

const size_t ndn::Name::npos = std::numeric_limits<size_t>::max()

static

Indicates "until the end" in getSubName() and compare().

Definition at line 707 of file name.hpp.

ndn-cxx: NDN C++ library with eXperimental eXtensions 0.8.1 documentation

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ Component

◆ component_container

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ Error

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ Name() [1/4]

◆ Name() [2/4]

◆ Name() [3/4]

◆ Name() [4/4]

Member Function Documentation

◆ append() [1/10]

◆ append() [2/10]

◆ append() [3/10]

◆ append() [4/10]

◆ append() [5/10]

◆ append() [6/10]

◆ append() [7/10]

◆ append() [8/10]

◆ append() [9/10]

◆ append() [10/10]

◆ appendByteOffset()

◆ appendImplicitSha256Digest() [1/2]

◆ appendImplicitSha256Digest() [2/2]

◆ appendKeyword() [1/2]

◆ appendKeyword() [2/2]

◆ appendNumber()

◆ appendNumberWithMarker()

◆ appendParametersSha256Digest() [1/2]

◆ appendParametersSha256Digest() [2/2]

◆ appendParametersSha256DigestPlaceholder()

◆ appendSegment()

◆ appendSequenceNumber()

◆ appendTimestamp()

◆ appendVersion()

◆ at()

◆ begin()

◆ clear()

◆ compare() [1/2]

◆ compare() [2/2]

◆ deepCopy()

◆ empty()

◆ end()

◆ equals()

◆ erase()

◆ get()

◆ getPrefix()

◆ getSubName()

◆ getSuccessor()

◆ hasWire()

◆ isPrefixOf()

◆ operator[]()

◆ push_back()

◆ rbegin()

◆ rend()

◆ set() [1/2]

◆ set() [2/2]

◆ size()

◆ toUri() [1/2]

◆ toUri() [2/2]

◆ wireDecode()

◆ wireEncode() [1/2]

◆ wireEncode() [2/2]