output.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_grn_obj_format

Macros
#define	GRN_OBJ_FORMAT_WITH_COLUMN_NAMES   (0x01 << 0)
#define	GRN_OBJ_FORMAT_AS_ARRAY   (0x01 << 3)
#define	GRN_OBJ_FORMAT_ASARRAY   GRN_OBJ_FORMAT_AS_ARRAY
#define	GRN_OBJ_FORMAT_WITH_WEIGHT   (0x01 << 4)
#define	GRN_OBJ_FORMAT_WEIGHT_FLOAT32   (0x01 << 5)
#define	GRN_OBJ_FORMAT_AUTO_FLUSH   (0x01 << 6)
#define	GRN_OBJ_FORMAT_INIT(format, format_nhits, format_offset, format_limit, format_hits_offset)
#define	GRN_OBJ_FORMAT_FIN(ctx, format)   grn_obj_format_fin((ctx), (format))

Typedefs
typedef struct _grn_obj_format	grn_obj_format

Functions
GRN_API grn_rc	grn_output_range_normalize (grn_ctx *ctx, int size, int *offset, int *limit)
GRN_API grn_rc	grn_obj_format_fin (grn_ctx *ctx, grn_obj_format *format)
GRN_API void	grn_output_obj (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, grn_obj *obj, grn_obj_format *format)
GRN_API void	grn_output_envelope (grn_ctx *ctx, grn_rc rc, grn_obj *head, grn_obj *body, grn_obj *foot, const char *file, int line)
GRN_API void	grn_output_envelope_open (grn_ctx *ctx, grn_obj *output)
GRN_API void	grn_output_envelope_close (grn_ctx *ctx, grn_obj *output, grn_rc rc, const char *file, int line)
GRN_API void	grn_output_array_open (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, const char *name, int n_elements)
GRN_API void	grn_output_array_close (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type)
GRN_API void	grn_output_map_open (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, const char *name, int n_elements)
GRN_API void	grn_output_map_close (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type)
GRN_API void	grn_output_null (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type)
GRN_API void	grn_output_int32 (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, int32_t value)
GRN_API void	grn_output_uint32 (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, uint32_t value)
GRN_API void	grn_output_int64 (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, int64_t value)
GRN_API void	grn_output_uint64 (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, uint64_t value)
GRN_API void	grn_output_float32 (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, float value)
GRN_API void	grn_output_float (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, double value)
GRN_API void	grn_output_cstr (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, const char *value)
GRN_API void	grn_output_str (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, const char *value, size_t value_len)
GRN_API void	grn_output_binary (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, const uint8_t *value, size_t value_len)
GRN_API void	grn_output_json (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, const uint8_t *value, size_t value_len)
GRN_API void	grn_output_bool (grn_ctx *ctx, grn_obj *outbuf, grn_content_type output_type, bool value)
GRN_API void	grn_ctx_output_flush (grn_ctx *ctx, int flags)
GRN_API void	grn_ctx_output_array_open (grn_ctx *ctx, const char *name, int nelements)
GRN_API void	grn_ctx_output_array_close (grn_ctx *ctx)
GRN_API void	grn_ctx_output_map_open (grn_ctx *ctx, const char *name, int nelements)
GRN_API void	grn_ctx_output_map_close (grn_ctx *ctx)
GRN_API void	grn_ctx_output_null (grn_ctx *ctx)
GRN_API void	grn_ctx_output_int32 (grn_ctx *ctx, int32_t value)
GRN_API void	grn_ctx_output_uint32 (grn_ctx *ctx, uint32_t value)
GRN_API void	grn_ctx_output_int64 (grn_ctx *ctx, int64_t value)
GRN_API void	grn_ctx_output_uint64 (grn_ctx *ctx, uint64_t value)
GRN_API void	grn_ctx_output_float32 (grn_ctx *ctx, float value)
GRN_API void	grn_ctx_output_float (grn_ctx *ctx, double value)
GRN_API void	grn_ctx_output_cstr (grn_ctx *ctx, const char *value)
GRN_API void	grn_ctx_output_str (grn_ctx *ctx, const char *value, size_t value_len)
GRN_API void	grn_ctx_output_bool (grn_ctx *ctx, bool value)
GRN_API void	grn_ctx_output_obj (grn_ctx *ctx, grn_obj *value, grn_obj_format *format)
GRN_API void	grn_ctx_output_result_set_open_metadata (grn_ctx *ctx, grn_obj *result_set, grn_obj_format *format, uint32_t n_additional_elements)
GRN_API void	grn_ctx_output_result_set_open (grn_ctx *ctx, grn_obj *result_set, grn_obj_format *format, uint32_t n_additional_elements)
GRN_API void	grn_ctx_output_result_set_close (grn_ctx *ctx, grn_obj *result_set, grn_obj_format *format)
GRN_API void	grn_ctx_output_result_set (grn_ctx *ctx, grn_obj *result_set, grn_obj_format *format)
GRN_API void	grn_ctx_output_table_columns (grn_ctx *ctx, grn_obj *table, grn_obj_format *format)
GRN_API void	grn_ctx_output_table_records_open (grn_ctx *ctx, int n_records)
GRN_API void	grn_ctx_output_table_records_content (grn_ctx *ctx, grn_obj *table, grn_obj_format *format)
GRN_API void	grn_ctx_output_table_records_close (grn_ctx *ctx)
GRN_API void	grn_ctx_output_table_records (grn_ctx *ctx, grn_obj *table, grn_obj_format *format)
GRN_API grn_content_type	grn_ctx_get_output_type (grn_ctx *ctx)
	Get the current output type of the context.
GRN_API grn_rc	grn_ctx_set_output_type (grn_ctx *ctx, grn_content_type type)
	Set the output type for the context when executing a command.
GRN_API const char *	grn_ctx_get_mime_type (grn_ctx *ctx)
GRN_API grn_rc	grn_text_otoj (grn_ctx *ctx, grn_obj *bulk, grn_obj *obj, grn_obj_format *format)

Macro Definition Documentation

GRN_OBJ_FORMAT_AS_ARRAY

#define GRN_OBJ_FORMAT_AS_ARRAY   (0x01 << 3)

GRN_OBJ_FORMAT_ASARRAY

#define GRN_OBJ_FORMAT_ASARRAY   GRN_OBJ_FORMAT_AS_ARRAY

GRN_OBJ_FORMAT_AUTO_FLUSH

#define GRN_OBJ_FORMAT_AUTO_FLUSH   (0x01 << 6)

GRN_OBJ_FORMAT_FIN

#define GRN_OBJ_FORMAT_FIN	(		ctx,
			format
	)		grn_obj_format_fin((ctx), (format))

GRN_OBJ_FORMAT_INIT

#define GRN_OBJ_FORMAT_INIT	(		format,
			format_nhits,
			format_offset,
			format_limit,
			format_hits_offset
	)

Value:

  do {                                                                         \
    GRN_PTR_INIT(&(format)->columns, GRN_OBJ_VECTOR, GRN_ID_NIL);              \
    (format)->nhits = (format_nhits);                                          \
    (format)->offset = (format_offset);                                        \
    (format)->limit = (format_limit);                                          \
    (format)->hits_offset = (format_hits_offset);                              \
    (format)->flags = 0;                                                       \
    (format)->expression = NULL;                                               \
  } while (0)

GRN_OBJ_FORMAT_WEIGHT_FLOAT32

#define GRN_OBJ_FORMAT_WEIGHT_FLOAT32   (0x01 << 5)

GRN_OBJ_FORMAT_WITH_COLUMN_NAMES

#define GRN_OBJ_FORMAT_WITH_COLUMN_NAMES   (0x01 << 0)

GRN_OBJ_FORMAT_WITH_WEIGHT

#define GRN_OBJ_FORMAT_WITH_WEIGHT   (0x01 << 4)

Typedef Documentation

grn_obj_format

typedef struct _grn_obj_format grn_obj_format

Function Documentation

grn_ctx_get_mime_type()

GRN_API const char * grn_ctx_get_mime_type

(

grn_ctx *

ctx

)

grn_ctx_get_output_type()

GRN_API grn_content_type grn_ctx_get_output_type

(

grn_ctx *

ctx

)

Get the current output type of the context.

Note

Normally, you don't need to call this function unless you need to check the output type explicitly.

Parameters

ctx	The context object.

Returns

Return the output type of the context, which is one of the values defined in grn_content_type. Return GRN_CONTENT_NONE if the context is invalid.

grn_ctx_output_array_close()

GRN_API void grn_ctx_output_array_close

(

grn_ctx *

ctx

)

grn_ctx_output_array_open()

GRN_API void grn_ctx_output_array_open	(	grn_ctx *	ctx,
		const char *	name,
		int	nelements
	)

grn_ctx_output_bool()

GRN_API void grn_ctx_output_bool	(	grn_ctx *	ctx,
		bool	value
	)

grn_ctx_output_cstr()

GRN_API void grn_ctx_output_cstr	(	grn_ctx *	ctx,
		const char *	value
	)

grn_ctx_output_float()

GRN_API void grn_ctx_output_float	(	grn_ctx *	ctx,
		double	value
	)

grn_ctx_output_float32()

GRN_API void grn_ctx_output_float32	(	grn_ctx *	ctx,
		float	value
	)

grn_ctx_output_flush()

GRN_API void grn_ctx_output_flush	(	grn_ctx *	ctx,
		int	flags
	)

grn_ctx_output_int32()

GRN_API void grn_ctx_output_int32	(	grn_ctx *	ctx,
		int32_t	value
	)

grn_ctx_output_int64()

GRN_API void grn_ctx_output_int64	(	grn_ctx *	ctx,
		int64_t	value
	)

grn_ctx_output_map_close()

GRN_API void grn_ctx_output_map_close

(

grn_ctx *

ctx

)

grn_ctx_output_map_open()

GRN_API void grn_ctx_output_map_open	(	grn_ctx *	ctx,
		const char *	name,
		int	nelements
	)

grn_ctx_output_null()

GRN_API void grn_ctx_output_null

(

grn_ctx *

ctx

)

grn_ctx_output_obj()

GRN_API void grn_ctx_output_obj	(	grn_ctx *	ctx,
		grn_obj *	value,
		grn_obj_format *	format
	)

grn_ctx_output_result_set()

GRN_API void grn_ctx_output_result_set	(	grn_ctx *	ctx,
		grn_obj *	result_set,
		grn_obj_format *	format
	)

grn_ctx_output_result_set_close()

GRN_API void grn_ctx_output_result_set_close	(	grn_ctx *	ctx,
		grn_obj *	result_set,
		grn_obj_format *	format
	)

grn_ctx_output_result_set_open()

GRN_API void grn_ctx_output_result_set_open	(	grn_ctx *	ctx,
		grn_obj *	result_set,
		grn_obj_format *	format,
		uint32_t	n_additional_elements
	)

grn_ctx_output_result_set_open_metadata()

GRN_API void grn_ctx_output_result_set_open_metadata	(	grn_ctx *	ctx,
		grn_obj *	result_set,
		grn_obj_format *	format,
		uint32_t	n_additional_elements
	)

grn_ctx_output_str()

GRN_API void grn_ctx_output_str	(	grn_ctx *	ctx,
		const char *	value,
		size_t	value_len
	)

grn_ctx_output_table_columns()

GRN_API void grn_ctx_output_table_columns	(	grn_ctx *	ctx,
		grn_obj *	table,
		grn_obj_format *	format
	)

grn_ctx_output_table_records()

GRN_API void grn_ctx_output_table_records	(	grn_ctx *	ctx,
		grn_obj *	table,
		grn_obj_format *	format
	)

grn_ctx_output_table_records_close()

GRN_API void grn_ctx_output_table_records_close

(

grn_ctx *

ctx

)

grn_ctx_output_table_records_content()

GRN_API void grn_ctx_output_table_records_content	(	grn_ctx *	ctx,
		grn_obj *	table,
		grn_obj_format *	format
	)

grn_ctx_output_table_records_open()

GRN_API void grn_ctx_output_table_records_open	(	grn_ctx *	ctx,
		int	n_records
	)

grn_ctx_output_uint32()

GRN_API void grn_ctx_output_uint32	(	grn_ctx *	ctx,
		uint32_t	value
	)

grn_ctx_output_uint64()

GRN_API void grn_ctx_output_uint64	(	grn_ctx *	ctx,
		uint64_t	value
	)

grn_ctx_set_output_type()

GRN_API grn_rc grn_ctx_set_output_type	(	grn_ctx *	ctx,
		grn_content_type	type
	)

Set the output type for the context when executing a command.

The output type determines the format of the result when executing a command using grn_expr_exec. If you use grn_ctx_send, the new output type isn't used because grn_ctx_send sets the output type internally based on the command.

Note

Normally, you don't need to call this function unless you need to change the output type explicitly when executing a command using grn_expr_exec.

Parameters

ctx	The context object.
type	The new output type to set.

Returns

GRN_SUCCESS on success, the appropriate grn_rc on error. For example, GRN_INVALID_ARGUMENT is returned if type is invalid.

grn_obj_format_fin()

GRN_API grn_rc grn_obj_format_fin	(	grn_ctx *	ctx,
		grn_obj_format *	format
	)

grn_output_array_close()

GRN_API void grn_output_array_close	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type
	)

grn_output_array_open()

GRN_API void grn_output_array_open	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		const char *	name,
		int	n_elements
	)

grn_output_binary()

GRN_API void grn_output_binary	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		const uint8_t *	value,
		size_t	value_len
	)

grn_output_bool()

GRN_API void grn_output_bool	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		bool	value
	)

grn_output_cstr()

GRN_API void grn_output_cstr	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		const char *	value
	)

grn_output_envelope()

GRN_API void grn_output_envelope	(	grn_ctx *	ctx,
		grn_rc	rc,
		grn_obj *	head,
		grn_obj *	body,
		grn_obj *	foot,
		const char *	file,
		int	line
	)

grn_output_envelope_close()

GRN_API void grn_output_envelope_close	(	grn_ctx *	ctx,
		grn_obj *	output,
		grn_rc	rc,
		const char *	file,
		int	line
	)

grn_output_envelope_open()

GRN_API void grn_output_envelope_open	(	grn_ctx *	ctx,
		grn_obj *	output
	)

grn_output_float()

GRN_API void grn_output_float	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		double	value
	)

grn_output_float32()

GRN_API void grn_output_float32	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		float	value
	)

grn_output_int32()

GRN_API void grn_output_int32	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		int32_t	value
	)

grn_output_int64()

GRN_API void grn_output_int64	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		int64_t	value
	)

grn_output_json()

GRN_API void grn_output_json	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		const uint8_t *	value,
		size_t	value_len
	)

grn_output_map_close()

GRN_API void grn_output_map_close	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type
	)

grn_output_map_open()

GRN_API void grn_output_map_open	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		const char *	name,
		int	n_elements
	)

grn_output_null()

GRN_API void grn_output_null	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type
	)

grn_output_obj()

GRN_API void grn_output_obj	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		grn_obj *	obj,
		grn_obj_format *	format
	)

grn_output_range_normalize()

GRN_API grn_rc grn_output_range_normalize	(	grn_ctx *	ctx,
		int	size,
		int *	offset,
		int *	limit
	)

grn_output_str()

GRN_API void grn_output_str	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		const char *	value,
		size_t	value_len
	)

grn_output_uint32()

GRN_API void grn_output_uint32	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		uint32_t	value
	)

grn_output_uint64()

GRN_API void grn_output_uint64	(	grn_ctx *	ctx,
		grn_obj *	outbuf,
		grn_content_type	output_type,
		uint64_t	value
	)

grn_text_otoj()

GRN_API grn_rc grn_text_otoj	(	grn_ctx *	ctx,
		grn_obj *	bulk,
		grn_obj *	obj,
		grn_obj_format *	format
	)