include/qapi/hmp-output-visitor.h

   1 /*
   2  * HMP string output Visitor
   3  *
   4  * Copyright Yandex N.V., 2021
   5  *
   6  * This work is licensed under the terms of the GNU GPL, version 2 or later.
   7  * See the COPYING file in the top-level directory.
   8  *
   9  */
  10
  11 #ifndef HMP_OUTPUT_VISITOR_H
  12 #define HMP_OUTPUT_VISITOR_H
  13
  14 #include "qapi/visitor.h"
  15
  16 typedef struct HMPOutputVisitor HMPOutputVisitor;
  17
  18 /**
  19  * Create a HMP string output visitor for @obj
  20  *
  21  * Flattens dicts/structures, only shows arrays borders.
  22  *
  23  * Errors are not expected to happen.
  24  *
  25  * The caller is responsible for freeing the visitor with
  26  * visit_free().
  27  */
  28 Visitor *hmp_output_visitor_new(char **result);
  29
  30 #endif