V8  latest master commit
V8 is Google's open source JavaScript engine
Public Member Functions | Friends
v8::Maybe< T > Class Template Reference

#include <v8.h>

Public Member Functions

V8_INLINE bool IsNothing () const
 
V8_INLINE bool IsJust () const
 
V8_INLINE T ToChecked () const
 
V8_INLINE void Check () const
 
V8_WARN_UNUSED_RESULT V8_INLINE bool To (T *out) const
 
V8_INLINE T FromJust () const
 
V8_INLINE T FromMaybe (const T &default_value) const
 
V8_INLINE bool operator== (const Maybe &other) const
 
V8_INLINE bool operator!= (const Maybe &other) const
 

Friends

template<class U >
Maybe< U > Nothing ()
 
template<class U >
Maybe< U > Just (const U &u)
 

Detailed Description

template<class T>
class v8::Maybe< T >

A simple Maybe type, representing an object which may or may not have a value, see https://hackage.haskell.org/package/base/docs/Data-Maybe.html.

If an API method returns a Maybe<>, the API method can potentially fail either because an exception is thrown, or because an exception is pending, e.g. because a previous API call threw an exception that hasn't been caught yet, or because a TerminateExecution exception was thrown. In that case, a "Nothing" value is returned.

Definition at line 60 of file v8.h.

Member Function Documentation

◆ Check()

template<class T >
V8_INLINE void v8::Maybe< T >::Check ( ) const
inline

Short-hand for ToChecked(), which doesn't return a value. To be used, where the actual value of the Maybe is not needed like Object::Set.

Definition at line 9916 of file v8.h.

◆ FromJust()

template<class T >
V8_INLINE T v8::Maybe< T >::FromJust ( ) const
inline

Converts this Maybe<> to a value of type T. If this Maybe<> is nothing (empty), V8 will crash the process.

Definition at line 9933 of file v8.h.

◆ FromMaybe()

template<class T >
V8_INLINE T v8::Maybe< T >::FromMaybe ( const T &  default_value) const
inline

Converts this Maybe<> to a value of type T, using a default value if this Maybe<> is nothing (empty).

Definition at line 9942 of file v8.h.

◆ IsJust()

template<class T >
V8_INLINE bool v8::Maybe< T >::IsJust ( ) const
inline

Definition at line 9905 of file v8.h.

◆ IsNothing()

template<class T >
V8_INLINE bool v8::Maybe< T >::IsNothing ( ) const
inline

Definition at line 9904 of file v8.h.

◆ operator!=()

template<class T >
V8_INLINE bool v8::Maybe< T >::operator!= ( const Maybe< T > &  other) const
inline

Definition at line 9951 of file v8.h.

◆ operator==()

template<class T >
V8_INLINE bool v8::Maybe< T >::operator== ( const Maybe< T > &  other) const
inline

Definition at line 9946 of file v8.h.

◆ To()

template<class T >
V8_WARN_UNUSED_RESULT V8_INLINE bool v8::Maybe< T >::To ( T *  out) const
inline

Converts this Maybe<> to a value of type T. If this Maybe<> is nothing (empty), |false| is returned and |out| is left untouched.

Definition at line 9924 of file v8.h.

◆ ToChecked()

template<class T >
V8_INLINE T v8::Maybe< T >::ToChecked ( ) const
inline

An alias for |FromJust|. Will crash if the Maybe<> is nothing.

Definition at line 9910 of file v8.h.

Friends And Related Function Documentation

◆ Just

template<class T >
template<class U >
Maybe<U> Just ( const U &  u)
friend

◆ Nothing

template<class T >
template<class U >
Maybe<U> Nothing ( )
friend

Definition at line 9969 of file v8.h.

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