iox2::PortNameView Class Reference

Non-owning view of a [PortName]. More...

#include <port_name.hpp>

Public Member Functions
	PortNameView (PortNameView &&) noexcept=default
	PortNameView (const PortNameView &)=default
auto	operator= (PortNameView &&) noexcept -> PortNameView &=default
auto	operator= (const PortNameView &) -> PortNameView &=default
	~PortNameView () noexcept=default
auto	native_ptr () const -> iox2_port_name_ptr
	Returns the native [iox2_port_name_ptr].
auto	to_string () const -> iox2::bb::StaticString< IOX2_PORT_NAME_LENGTH >
	Returns a [iox2::bb::StaticString] containing the [PortName].
auto	to_owned () const -> PortName
	Creates a copy of the corresponding [PortName] and returns it.

Static Public Member Functions
static auto	from_native_ptr (iox2_port_name_ptr m_ptr) -> PortNameView
	Creates a [PortNameView] from a native [iox2_port_name_ptr].

Detailed Description

Non-owning view of a [PortName].

Definition at line 25 of file port_name.hpp.

Constructor & Destructor Documentation

PortNameView() [1/2]

iox2::PortNameView::PortNameView ( PortNameView &&  )

defaultnoexcept

PortNameView() [2/2]

iox2::PortNameView::PortNameView ( const PortNameView &  )

default

~PortNameView()

iox2::PortNameView::~PortNameView ( )

defaultnoexcept

Member Function Documentation

from_native_ptr()

static auto iox2::PortNameView::from_native_ptr ( iox2_port_name_ptr  m_ptr ) -> PortNameView

static

Creates a [PortNameView] from a native [iox2_port_name_ptr].

Referenced by iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::name(), iox2::Listener< ServiceType >::name(), iox2::Publisher< S, Payload, UserHeader >::name(), iox2::Reader< S, KeyType >::name(), iox2::Server< Service, RequestPayload, RequestHeader, ResponsePayload, ResponseHeader >::name(), iox2::Subscriber< S, Payload, UserHeader >::name(), and iox2::Writer< S, KeyType >::name().

native_ptr()

auto iox2::PortNameView::native_ptr

(

)

const -> iox2_port_name_ptr

Returns the native [iox2_port_name_ptr].

operator=() [1/2]

auto iox2::PortNameView::operator= ( const PortNameView &  ) -> PortNameView &=default

default

operator=() [2/2]

auto iox2::PortNameView::operator= ( PortNameView &&  ) -> PortNameView &=default

defaultnoexcept

to_owned()

auto iox2::PortNameView::to_owned

(

)

const -> PortName

Creates a copy of the corresponding [PortName] and returns it.

to_string()

auto iox2::PortNameView::to_string

(

)

const -> iox2::bb::StaticString< IOX2_PORT_NAME_LENGTH >

Returns a [iox2::bb::StaticString] containing the [PortName].

---

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

• iox2/port_name.hpp