Decoder.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_Decoder_hh__
#define avro_Decoder_hh__

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

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


namespace avro {

class AVRO_DECL Decoder {
public:
    virtual ~Decoder() { };
    virtual void init(InputStream& is) = 0;

    virtual void decodeNull() = 0;

    virtual bool decodeBool() = 0;

    virtual int32_t decodeInt() = 0;

    virtual int64_t decodeLong() = 0;

    virtual float decodeFloat() = 0;

    virtual double decodeDouble() = 0;

    std::string decodeString() {
        std::string result;
        decodeString(result);
        return result;
    }

    virtual void decodeString(std::string& value) = 0;

    virtual void skipString() = 0;

    std::vector<uint8_t> decodeBytes() {
        std::vector<uint8_t> result;
        decodeBytes(result);
        return result;
    }

    virtual void decodeBytes(std::vector<uint8_t>& value) = 0;

    virtual void skipBytes() = 0;

    std::vector<uint8_t> decodeFixed(size_t n) {
        std::vector<uint8_t> result;
        decodeFixed(n, result);
        return result;
    }

    virtual void decodeFixed(size_t n, std::vector<uint8_t>& value) = 0;

    virtual void skipFixed(size_t n) = 0;

    virtual size_t decodeEnum() = 0;

    virtual size_t arrayStart() = 0;

    virtual size_t arrayNext() = 0;

    virtual size_t skipArray() = 0;

    virtual size_t mapStart() = 0;

    virtual size_t mapNext() = 0;

    virtual size_t skipMap() = 0;

    virtual size_t decodeUnionIndex() = 0;

    virtual void drain() = 0;
};

typedef std::shared_ptr<Decoder> DecoderPtr;

class AVRO_DECL ResolvingDecoder : public Decoder {
public:
    virtual const std::vector<size_t>& fieldOrder() = 0;
};

typedef std::shared_ptr<ResolvingDecoder> ResolvingDecoderPtr;
AVRO_DECL DecoderPtr binaryDecoder();

AVRO_DECL DecoderPtr validatingDecoder(const ValidSchema& schema,
    const DecoderPtr& base);

AVRO_DECL DecoderPtr jsonDecoder(const ValidSchema& schema);

AVRO_DECL ResolvingDecoderPtr resolvingDecoder(const ValidSchema& writer,
    const ValidSchema& reader, const DecoderPtr& base);


}   // namespace avro

#endif