vlink::Status::Unknown Struct Reference

Placeholder status returned when the transport reports an unrecognised event type. More...

#include <status.h>

Inheritance diagram for vlink::Status::Unknown:

Collaboration diagram for vlink::Status::Unknown:

Public Member Functions
Type	get_type () const override
	Returns kUnknown.
std::string	get_string () const override
	Returns "Unknown".
Public Member Functions inherited from vlink::Status::Base
template<typename T>
std::shared_ptr< T >	as () const
	Safely downcasts this status to a concrete type T.

Friends
VLINK_EXPORT friend std::ostream &	operator<< (std::ostream &ostream, const Unknown &status) noexcept
	Writes "Unknown" to ostream.

Additional Inherited Members
Protected Member Functions inherited from vlink::Status::Base
	Base ()
virtual	~Base ()

Detailed Description

Placeholder status returned when the transport reports an unrecognised event type.

Callers should check get_type() == kUnknown and skip processing.

Member Function Documentation

get_string()

std::string vlink::Status::Unknown::get_string ( ) const

nodiscardoverridevirtual

Returns "Unknown".

Returns

Descriptive string.

Implements vlink::Status::Base.

get_type()

Type vlink::Status::Unknown::get_type ( ) const

nodiscardoverridevirtual

Returns kUnknown.

Returns

Always kUnknown.

Implements vlink::Status::Base.

Friends And Related Symbol Documentation

operator<<

VLINK_EXPORT friend std::ostream & operator<< ( std::ostream & ostream, const Unknown & status )

friend

Writes "Unknown" to ostream.

Parameters

ostream	Output stream.
status	This Unknown status.

Returns

Reference to ostream.

---

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

• include/vlink/extension/status.h