Typedefs | Functions | Variables
Generic Value Optional management

Typedefs

typedef Eina_Value_Union Eina_Value_Optional
 
typedef struct _Eina_Value_Struct Eina_Value_Struct
 Value type for EINA_VALUE_TYPE_STRUCT. More...
 

Functions

static Eina_Valueeina_value_optional_empty_new (void)
 Create an empty optional. More...
 
Eina_Valueeina_value_optional_new (const Eina_Value_Type *subtype, const void *value)
 Create an optional eina value with the passed value. More...
 
static Eina_Bool eina_value_optional_empty_is (const Eina_Value *value, Eina_Bool *is_empty)
 Function to know if an eina optional is empty or not. More...
 
Eina_Bool eina_value_optional_pset (Eina_Value *value, Eina_Value_Type const *subtype, const void *subvalue)
 Set the optional with a value. More...
 
Eina_Bool eina_value_optional_pget (Eina_Value *value, void *subvalue)
 Get the value from an optional. More...
 
Eina_Bool eina_value_optional_reset (Eina_Value *value)
 Resets eina optional to empty. More...
 
static const Eina_Value_Typeeina_value_optional_type_get (Eina_Value *value)
 Get type from value that is stored on Eina Value Optional. More...
 

Variables

const Eina_Value_TypeEINA_VALUE_TYPE_OPTIONAL
 manages optional type. More...
 
const Eina_Value_TypeEINA_VALUE_TYPE_OPTIONAL = NULL
 manages optional type. More...
 

Detailed Description

Typedef Documentation

§ Eina_Value_Struct

Eina_Value_Optional type to be used with Eina_Value_Struct

Value type for EINA_VALUE_TYPE_STRUCT.

See also
_Eina_Value_Struct explains fields.
Since
1.2
1.17

Function Documentation

§ eina_value_optional_empty_new()

static Eina_Value* eina_value_optional_empty_new ( void  )
inlinestatic

Create an empty optional.

This is the same as eina_value_new(EINA_VALUE_TYPE_OPTIONAL).

Returns
returns an empty optional eina value.
Since
1.17

§ eina_value_optional_new()

Eina_Value* eina_value_optional_new ( const Eina_Value_Type subtype,
const void *  value 
)

Create an optional eina value with the passed value.

Parameters
subtypeEina_Value_Type of parameter value
valueThe value to be used to construct optional eina value
Returns
EINA_TRUE on success, EINA_FALSE otherwise.
Since
1.17

§ eina_value_optional_empty_is()

static Eina_Bool eina_value_optional_empty_is ( const Eina_Value value,
Eina_Bool is_empty 
)
inlinestatic

Function to know if an eina optional is empty or not.

Parameters
valueEina Value Optional
is_emptyEINA_TRUE if optional is empty, EINA_FALSE otherwise.
Returns
EINA_TRUE on success, EINA_FALSE otherwise.
Since
1.17

§ eina_value_optional_pset()

Eina_Bool eina_value_optional_pset ( Eina_Value value,
Eina_Value_Type const *  subtype,
const void *  subvalue 
)

Set the optional with a value.

Parameters
valueEina Value Optional to be set with subvalue
subtypeType of subvalue
subvalueValue to be set in optional
Returns
EINA_TRUE on success, EINA_FALSE otherwise.
Since
1.17

§ eina_value_optional_pget()

Eina_Bool eina_value_optional_pget ( Eina_Value value,
void *  subvalue 
)

Get the value from an optional.

Parameters
valueEina Value Optional to get value from
subvaluePointer to where value is to be copied to. You must use the correct type according to eina_value_optional_type_get
Returns
EINA_TRUE on success, EINA_FALSE otherwise.
Since
1.17

§ eina_value_optional_reset()

Eina_Bool eina_value_optional_reset ( Eina_Value value)

Resets eina optional to empty.

Parameters
valueEina Value Optional
Returns
EINA_TRUE on success, EINA_FALSE otherwise.
Since
1.17

§ eina_value_optional_type_get()

static const Eina_Value_Type* eina_value_optional_type_get ( Eina_Value value)
inlinestatic

Get type from value that is stored on Eina Value Optional.

Parameters
valueEina Value Optional
Returns
The optional sub-type.
Since
1.17

Variable Documentation

§ EINA_VALUE_TYPE_OPTIONAL [1/2]

const Eina_Value_Type* EINA_VALUE_TYPE_OPTIONAL

manages optional type.

Since
1.17

§ EINA_VALUE_TYPE_OPTIONAL [2/2]

EINA_VALUE_TYPE_OPTIONAL = NULL

manages optional type.

Since
1.17