Seastar
High performance C++ framework for concurrent servers
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | Public Attributes | List of all members
seastar::httpd::api_doc Struct Reference
Inheritance diagram for seastar::httpd::api_doc:
seastar::json::json_base seastar::json::jsonable

Public Member Functions

void register_params ()
 
 api_doc (const api_doc &e)
 
template<class T >
api_docoperator= (const T &e)
 
api_docoperator= (const api_doc &e)
 
virtual std::string to_json () const
 
virtual future write (output_stream< char > &) const
 write to an output stream More...
 
virtual bool is_verify () const
 
virtual void add (json_base_element *element, std::string name, bool mandatory=false)
 

Public Attributes

json::json_element< std::string > path
 
json::json_element< std::string > description
 
std::vector< json_base_element * > _elements
 

Member Function Documentation

◆ add()

virtual void seastar::json::json_base::add ( json_base_element element,
std::string  name,
bool  mandatory = false 
)
virtualinherited

Register an element in an object

Parameters
elementthe element to be added
namethe element name
mandatoryis this element mandatory.

◆ is_verify()

virtual bool seastar::json::json_base::is_verify ( ) const
virtualinherited

Check that all mandatory elements are set

Returns
true if all mandatory parameters are set

◆ to_json()

virtual std::string seastar::json::json_base::to_json ( ) const
virtualinherited

create a formatted string of the object.

Returns
the object formatted.

Implements seastar::json::jsonable.

◆ write()

virtual future seastar::json::json_base::write ( output_stream< char > &  ) const
virtualinherited

write to an output stream

Reimplemented from seastar::json::jsonable.


The documentation for this struct was generated from the following file: