folly::settings::detail::SettingWrapper< T, TrivialPtr > Class Template Reference

#include <Settings.h>

Public Member Functions
std::conditional_t< IsSmallPOD< T >::value, T, const T & >	operator* () const
const T *	operator-> () const
void	set (const T &t, StringPiece reason="api")
const T &	defaultValue () const
	SettingWrapper (SettingCore< T > &core)

Private Attributes
SettingCore< T > &	core_

Friends
class	folly::settings::Snapshot

Detailed Description

template<class T, std::atomic< uint64_t > * TrivialPtr>
class folly::settings::detail::SettingWrapper< T, TrivialPtr >

Parameters

TrivialPtr

location of the small type storage. Optimization for better inlining.

Definition at line 36 of file Settings.h.

Constructor & Destructor Documentation

template<class T , std::atomic< uint64_t > * TrivialPtr>

folly::settings::detail::SettingWrapper< T, TrivialPtr >::SettingWrapper ( SettingCore< T > &  core )

inlineexplicit

Definition at line 76 of file Settings.h.

: core_(core) {}

Member Function Documentation

template<class T , std::atomic< uint64_t > * TrivialPtr>

const T& folly::settings::detail::SettingWrapper< T, TrivialPtr >::defaultValue ( ) const

inline

Returns the default value this setting was constructed with. NOTE: SettingsMetadata is type-agnostic, so it only stores the string representation of the default value. This method returns the actual value that was passed on construction.

Definition at line 72 of file Settings.h.

References folly::settings::detail::SettingWrapper< T, TrivialPtr >::core_.

                                {
    return core_.defaultValue();
  }

template<class T , std::atomic< uint64_t > * TrivialPtr>

std::conditional_t<IsSmallPOD<T>::value, T, const T&> folly::settings::detail::SettingWrapper< T, TrivialPtr >::operator* ( ) const

inline

Returns the setting's current value.

As an optimization, returns by value for small types, and by const& for larger types. Note that the returned reference is not guaranteed to be long-lived and should not be saved anywhere. In particular, a set() call might invalidate a reference obtained here after some amount of time (on the order of minutes).

Definition at line 47 of file Settings.h.

References folly::settings::detail::SettingWrapper< T, TrivialPtr >::core_.

Referenced by folly::settings::detail::SnapshotSettingWrapper< T >::operator->().

                                                                      {
    return core_.getWithHint(*TrivialPtr);
  }

template<class T , std::atomic< uint64_t > * TrivialPtr>

const T* folly::settings::detail::SettingWrapper< T, TrivialPtr >::operator-> ( ) const

inline

Definition at line 50 of file Settings.h.

References folly::settings::detail::SettingWrapper< T, TrivialPtr >::core_.

                              {
    return &core_.getSlow().value;
  }

template<class T , std::atomic< uint64_t > * TrivialPtr>

void folly::settings::detail::SettingWrapper< T, TrivialPtr >::set ( const T &  t, StringPiece  reason = "api"  )

inline

Atomically updates the setting's current value. Will invalidate any previous calls to operator*() after some amount of time (on the order of minutes).

Parameters

reason

Will be stored with the current value, useful for debugging.

Exceptions

std::runtime_error

If we can't convert t to string.

Definition at line 62 of file Settings.h.

References folly::settings::detail::SettingWrapper< T, TrivialPtr >::core_.

                                                   {
    core_.set(t, reason);
  }

Friends And Related Function Documentation

template<class T , std::atomic< uint64_t > * TrivialPtr>

friend class folly::settings::Snapshot

friend

Definition at line 80 of file Settings.h.

Member Data Documentation

template<class T , std::atomic< uint64_t > * TrivialPtr>

SettingCore<T>& folly::settings::detail::SettingWrapper< T, TrivialPtr >::core_

private

Definition at line 79 of file Settings.h.

Referenced by folly::settings::detail::SettingWrapper< T, TrivialPtr >::defaultValue(), folly::settings::detail::SettingWrapper< T, TrivialPtr >::operator*(), folly::settings::detail::SnapshotSettingWrapper< T >::operator*(), folly::settings::detail::SettingWrapper< T, TrivialPtr >::operator->(), folly::settings::detail::SettingWrapper< T, TrivialPtr >::set(), and folly::settings::detail::SnapshotSettingWrapper< T >::set().

---

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

• proxygen/folly/folly/experimental/settings/Settings.h