Encoder.hh

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef avro_Encoder_hh__
#define avro_Encoder_hh__

#include "Config.hh"
#include <stdint.h>
#include <string>
#include <vector>
#include <memory>

#include "ValidSchema.hh"
#include "Stream.hh"


namespace avro {

class AVRO_DECL Encoder {
public:
    virtual ~Encoder() { };
    virtual void init(OutputStream& os) = 0;

    virtual void flush() = 0;

    virtual int64_t byteCount() const = 0;

    virtual void encodeNull() = 0;

    virtual void encodeBool(bool b) = 0;

    virtual void encodeInt(int32_t i) = 0;

    virtual void encodeLong(int64_t l) = 0;

    virtual void encodeFloat(float f) = 0;

    virtual void encodeDouble(double d) = 0;

    virtual void encodeString(const std::string& s) = 0;

    virtual void encodeBytes(const uint8_t *bytes, size_t len) = 0;

    void encodeBytes(const std::vector<uint8_t>& bytes) {
        uint8_t b = 0;
        encodeBytes(bytes.empty() ? &b : bytes.data(), bytes.size());
    }

    virtual void encodeFixed(const uint8_t *bytes, size_t len) = 0;

    void encodeFixed(const std::vector<uint8_t>& bytes) {
        encodeFixed(bytes.data(), bytes.size());
    }

    virtual void encodeEnum(size_t e) = 0;

    virtual void arrayStart() = 0;

    virtual void arrayEnd() = 0;

    virtual void mapStart() = 0;

    virtual void mapEnd() = 0;

    virtual void setItemCount(size_t count) = 0;

    virtual void startItem() = 0;

    virtual void encodeUnionIndex(size_t e) = 0;
};

typedef std::shared_ptr<Encoder> EncoderPtr;

AVRO_DECL EncoderPtr binaryEncoder();

AVRO_DECL EncoderPtr validatingEncoder(const ValidSchema& schema,
    const EncoderPtr& base);

AVRO_DECL EncoderPtr jsonEncoder(const ValidSchema& schema);

AVRO_DECL EncoderPtr jsonPrettyEncoder(const ValidSchema& schema);

}   // namespace avro

#endif