viewjson.h

/*
 * SPDX-FileCopyrightText: (C) 2015-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef VIEWJSON_H
#define VIEWJSON_H

#include <Cutelyst/Plugins/View/json_export.h>
#include <Cutelyst/view.h>

namespace Cutelyst {

class ViewJsonPrivate;
class CUTELYST_VIEW_JSON_EXPORT ViewJson final : public View
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(ViewJson)
public:
    explicit ViewJson(QObject *parent, const QString &name = QString());

    enum JsonFormat {
        Indented, 
        Compact   
    };
    Q_ENUM(JsonFormat)

    
    [[nodiscard]] JsonFormat outputFormat() const;

    void setOutputFormat(JsonFormat format);

    enum ExposeMode {
        All,              
        String,           
        StringList,       
        RegularExpression 
    };
    Q_ENUM(ExposeMode)

    
    [[nodiscard]] ExposeMode exposeStashMode() const;

    void setExposeStash(const QString &key);

    void setExposeStash(const QStringList &keys);

    void setExposeStash(const QRegularExpression &re);

    void setXJsonHeader(bool enable);

    [[nodiscard]] bool xJsonHeader() const;

    QByteArray render(Context *c) const final;
};

} // namespace Cutelyst

#endif // VIEWJSON_H