Fix version for v6.2.0-rc2 release
[qemu.git] / include / qapi / string-output-visitor.h
1 /*
2 * String printing Visitor
3 *
4 * Copyright Red Hat, Inc. 2012
5 *
6 * Author: Paolo Bonzini <pbonzini@redhat.com>
7 *
8 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
9 * See the COPYING.LIB file in the top-level directory.
10 *
11 */
12
13 #ifndef STRING_OUTPUT_VISITOR_H
14 #define STRING_OUTPUT_VISITOR_H
15
16 #include "qapi/visitor.h"
17
18 typedef struct StringOutputVisitor StringOutputVisitor;
19
20 /*
21 * Create a new string output visitor.
22 *
23 * Using @human creates output that is a bit easier for humans to read
24 * (for example, showing integer values in both decimal and hex).
25 *
26 * If everything else succeeds, pass @result to visit_complete() to
27 * collect the result of the visit.
28 *
29 * The string output visitor does not implement support for visiting
30 * QAPI structs, alternates, null, or arbitrary QTypes. It also
31 * requires a non-null list argument to visit_start_list().
32 */
33 Visitor *string_output_visitor_new(bool human, char **result);
34
35 #endif