Holds values for client options. More...

#include <client_options.hpp>

Public Member Functions
	ClientOptions ()
	Constructs a ClientOptions object with default values. More...

	~ClientOptions ()

	ClientOptions (ClientOptions &&) noexcept

ClientOptions &	operator= (const ClientOptions &options)

ClientOptions &	operator= (ClientOptions &&options)

ClientOptions	clone () const

ClientOptions &	withName (std::string name)
	Sets the client name. More...

const std::string &	name () const
	Gets the previously set (or default) client name. More...

ClientOptions &	withVersion (std::string version)
	Sets the client version. More...

const std::string &	version () const
	Gets the previously set (or default) client version. More...

Detailed Description

Holds values for client options.

Definition at line 11 of file client_options.hpp.

Constructor & Destructor Documentation

◆ ClientOptions() [1/2]

mbgl::ClientOptions::ClientOptions ( )

Constructs a ClientOptions object with default values.

◆ ~ClientOptions()

mbgl::ClientOptions::~ClientOptions ( )

◆ ClientOptions() [2/2]

mbgl::ClientOptions::ClientOptions ( ClientOptions && )

noexcept

Member Function Documentation

◆ clone()

ClientOptions mbgl::ClientOptions::clone ( ) const

◆ name()

const std::string& mbgl::ClientOptions::name ( ) const

Gets the previously set (or default) client name.

Returns: client name

◆ operator=() [1/2]

ClientOptions& mbgl::ClientOptions::operator= ( ClientOptions && options )

◆ operator=() [2/2]

ClientOptions& mbgl::ClientOptions::operator= ( const ClientOptions & options )

◆ version()

const std::string& mbgl::ClientOptions::version ( ) const

Gets the previously set (or default) client version.

Returns: client version

◆ withName()

ClientOptions& mbgl::ClientOptions::withName ( std::string name )

Sets the client name.

Parameters

name	Client name.

Returns: ClientOptions for chaining options together.

◆ withVersion()

ClientOptions& mbgl::ClientOptions::withVersion ( std::string version )

Sets the client version.