result.c File Reference

Implementation of the Result enumeration type, related constants and functions. More...

#include <stdbool.h>
#include "ds/result.h"

Include dependency graph for result.c:

Go to the source code of this file.

Functions
bool	ds_result_is_ok (ds_result_t const self)
	Returns true if self is Ok. More...
bool	ds_result_is_err (ds_result_t const self)
	Returns true if self is a DS_RESULT_ERR_* variant. More...

Detailed Description

Implementation of the Result enumeration type, related constants and functions.

Author

Avinash Maddikonda (svass.nosp@m.saka.nosp@m.vi@gm.nosp@m.ail..nosp@m.com)

Since

0.6.0

Date

2023-08-01

Definition in file result.c.

Function Documentation

ds_result_is_err()

bool ds_result_is_err

(

ds_result_t

self

)

Returns true if self is a DS_RESULT_ERR_* variant.

Parameters

self	The value to check.

Returns

true if self is a DS_RESULT_ERR_* variant. false otherwise.

Examples

Basic usage:

ds_result_t const x = DS_RESULT_OK;
assert (!ds_result_is_err (x));
 
ds_result_t const y = DS_RESULT_ERR_PTR_IS_NULL;
assert (ds_result_is_err (y));

Definition at line 19 of file result.c.

Here is the call graph for this function:

ds_result_is_ok()

bool ds_result_is_ok

(

ds_result_t

self

)

Returns true if self is Ok.

Parameters

self	The value to check.

Returns

true if self is Ok, and false otherwise.

Examples

Basic usage:

ds_result_t const x = DS_RESULT_OK;
assert (ds_result_is_ok (x));
 
ds_result_t const y = DS_RESULT_ERR_PTR_IS_NULL;
assert (!ds_result_is_ok (y));

Definition at line 13 of file result.c.

Here is the caller graph for this function: