# memberdef

refid: ab1059583ebd55c0047b49d5933883a03
name: DataFileReader
definition: avro::DataFileReader< T >::DataFileReader
argsstring: (const char *filename)
scope: avro::DataFileReader< T >
briefdescription:
Constructs the reader for the given file and the reader is
expected to use the schema that is used with data.


refid: ab606c7550cc5f949b23a39efb053be93
name: DataFileReader
definition: avro::DataFileReader< T >::DataFileReader
argsstring: (std::auto_ptr< DataFileReaderBase > base)
scope: avro::DataFileReader< T >
briefdescription: Constructs a reader using the reader base.
detaileddescription:
 This form of constructor
allows the user to examine the schema of a given file and then
decide to use the right type of data to be desrialize. Without this
the user must know the type of data for the template <em>before</em>
he knows the schema within the file.
The schema present in the data file will be used for reading
from this reader.


refid: a1ae6ff5ef8c090cb5bee0f325225ab09
name: DataFileReader
definition: avro::DataFileReader< T >::DataFileReader
argsstring: (std::auto_ptr< DataFileReaderBase > base, const ValidSchema &readerSchema)
scope: avro::DataFileReader< T >
briefdescription: Constructs a reader using the reader base.
detaileddescription:
 This form of constructor
allows the user to examine the schema of a given file and then
decide to use the right type of data to be desrialize. Without this
the user must know the type of data for the template <em>before</em>
he knows the schema within the file.
The argument readerSchema will be used for reading
from this reader.


refid: a9d75e6f33030737fb15da2c57e63ec9f
name: read
definition: bool avro::DataFileReader< T >::read
type: bool
argsstring: (T &datum)
scope: avro::DataFileReader< T >
briefdescription: Reads the next entry from the data file.
detaileddescription:
\return true if an object has been successfully read into \p datum and
false if there are no more entries in the file.


refid: a432b65070ff58dd4cf3ef0d776bdd0cc
name: init
definition: void avro::DataFileReaderBase::init
type: void
argsstring: (const ValidSchema &readerSchema)
scope: avro::DataFileReaderBase
briefdescription: Initializes the reader to read objects according to the given schema.
detaileddescription:
 This gives an opportinity for the reader to see the schema
in the data file before deciding the right schema to use for reading.
This must be called exactly once after constructing the
DataFileReaderBase object.


refid: adf128ce4d3165dedba19b09ea478f756
name: DataFileWriter
definition: avro::DataFileWriter< T >::DataFileWriter
scope: avro::DataFileWriter< T >
briefdescription: Constructs a new data file.
argsstring:
(const char *filename, const ValidSchema &schema, size_t syncInterval=16 *1024, Codec codec=NULL_CODEC)


refid: a4a2306d75ec6a6ef84215c5781267eaf
name: init
definition: virtual void avro::Decoder::init
type: void
argsstring: (InputStream &is)=0
scope: avro::Decoder
briefdescription:
All future decoding will come from is, which should be valid
until replaced by another call to init() or this Decoder is
destructed.


refid: abff413217a31b08e9f66e361b2a18b6e
name: decodeFixed
definition: std::vector<uint8_t> avro::Decoder::decodeFixed
type: std::vector< uint8_t >
argsstring: (size_t n)
scope: avro::Decoder
briefdescription: Decodes fixed length binary from the current stream.
detaileddescription:
\param[in] n The size (byte count) of the fixed being read.
\return The fixed data that has been read. The size of the returned
vector is guaranteed to be equal to \p n.


refid: a156efba788d2aa51d17a57edf7793632
name: decodeFixed
definition: virtual void avro::Decoder::decodeFixed
type: void
argsstring: (size_t n, std::vector< uint8_t > &value)=0
scope: avro::Decoder
briefdescription: Decodes a fixed from the current stream.
detaileddescription:
\param[in] n The size (byte count) of the fixed being read.
\param[out] value The value that receives the fixed. The vector will
be size-adjusted based on the fixed's size.


refid: a861e396bae1f736632948ba99c7b4317
name: skipArray
definition: virtual size_t avro::Decoder::skipArray
type: size_t
argsstring: ()=0
scope: avro::Decoder
briefdescription: Tries to skip an array.
detaileddescription:
 If it can, it returns 0. Otherwise
it returns the number of elements to be skipped. The client
should skip the individual items. In such cases, skipArray
is identical to arrayStart.  


refid: a70cfe7538606efec884549eba9c7545e
name: skipMap
definition: virtual size_t avro::Decoder::skipMap
type: size_t
argsstring: ()=0
scope: avro::Decoder
briefdescription: Tries to skip a map.
detaileddescription:
 If it can, it returns 0. Otherwise
it returns the number of elements to be skipped. The client
should skip the individual items. In such cases, skipMap
is identical to mapStart.  


refid: a675355be38b2119a1f7472e483267bb3
name: init
definition: virtual void avro::Encoder::init
type: void
argsstring: (OutputStream &os)=0
scope: avro::Encoder
briefdescription:
All future encodings will go to os, which should be valid until
it is reset with another call to init() or the encoder is
destructed.


refid: a5c2644016d6563e86b34407afdef3002
name: GenericArray
definition: avro::GenericArray::GenericArray
argsstring: (const NodePtr &schema)
scope: avro::GenericArray
briefdescription:
Constructs a generic array corresponding to the given schema \p schema,
which should be of Avro type array.


refid: aa35956e7067eecb2f1ff1fe44543893f
name: value
definition: T& avro::GenericDatum::value
type: T &
argsstring: ()
scope: avro::GenericDatum
briefdescription: Returns the reference to the value held by this datum, which can be used to change the contents.
detaileddescription:
 Please note that only
value can be changed, the data type of the value held cannot
be changed.

T The type for the value. This must correspond to the
avro type returned by type().


refid: ae4114927e789d6bdd293437d5ccb5327
name: GenericDatum
definition: avro::GenericDatum::GenericDatum
argsstring: (const NodePtr &schema)
scope: avro::GenericDatum
briefdescription: Constructs a datum corresponding to the given avro type.
detaileddescription:
The value will the appropraite default corresponding to the
data type.
\param schema The schema that defines the avro type.


refid: aed0dc0b87604920599d11dc1150f24ac
name: GenericEnum
definition: avro::GenericEnum::GenericEnum
argsstring: (const NodePtr &schema)
scope: avro::GenericEnum
briefdescription:
Constructs a generic enum corresponding to the given schema \p schema,
which should be of Avro type enum.


refid: ac44c584cbf71294a5f610d21f739f50a
name: GenericFixed
definition: avro::GenericFixed::GenericFixed
argsstring: (const NodePtr &schema)
scope: avro::GenericFixed
briefdescription:
Constructs a generic enum corresponding to the given schema \p schema,
which should be of Avro type fixed.


refid: a44649fa4cc1cb26983411ce0dbc36372
name: GenericMap
definition: avro::GenericMap::GenericMap
argsstring: (const NodePtr &schema)
scope: avro::GenericMap
briefdescription:
Constructs a generic map corresponding to the given schema \p schema,
which should be of Avro type map.


refid: ac84a8322543af3bfab5739aff040adbb
name: GenericReader
definition: avro::GenericReader::GenericReader
argsstring: (const ValidSchema &writerSchema, const ValidSchema &readerSchema, const DecoderPtr &decoder)
scope: avro::GenericReader
briefdescription:
Constructs a reader for the given reader's schema \c readerSchema
using the given
decoder which holds data matching writer's schema \c writerSchema.


refid: a7707d865e3a788e0e6e03131b92fc245
name: GenericRecord
definition: avro::GenericRecord::GenericRecord
argsstring: (const NodePtr &schema)
scope: avro::GenericRecord
briefdescription:
Constructs a generic record corresponding to the given schema \p schema,
which should be of Avro type record.


refid: a03edd615e245e47d7a58bedf534c5a9a
name: field
definition: GenericDatum& avro::GenericRecord::field
type: GenericDatum &
argsstring: (const std::string &name)
scope: avro::GenericRecord
briefdescription:
Returns the reference to the field with the given name \p name,
which can be used to change the contents.


refid: a1528ea45824d7fa38bae6154e0dbe13d
name: fieldAt
definition: GenericDatum& avro::GenericRecord::fieldAt
type: GenericDatum &
argsstring: (size_t pos)
scope: avro::GenericRecord
briefdescription:
Returns the reference to the field at the given position \p pos,
which can be used to change the contents.


refid: a29a00498e168284778c0e782e385e968
name: GenericUnion
definition: avro::GenericUnion::GenericUnion
argsstring: (const NodePtr &schema)
scope: avro::GenericUnion
briefdescription: Constructs a generic union corresponding to the given schema \p schema, and the given value.
detaileddescription:
 The schema should be of Avro type union
and the value should correspond to one of the branches of the union.


refid: a87767c15b0661981d24f7a42bfcef6b5
name: next
definition: virtual bool avro::InputStream::next
type: bool
argsstring: (const uint8_t **data, size_t *len)=0
scope: avro::InputStream
briefdescription: Returns some of available data.
detaileddescription:
Returns true if some data is available, false if no more data is
available or an error has occurred.


refid: acfacc38121fd95e0644b480618b610f3
name: byteCount
definition: virtual size_t avro::InputStream::byteCount
type: size_t
argsstring: () const =0
scope: avro::InputStream
briefdescription: Returns the number of bytes read from this stream so far.
detaileddescription:
All the bytes made available through next are considered
to be used unless, retutned back using backup.


refid: aa1aa07d16762a18f2be72b90e468f742
name: IndexMap
type: std::map< std::string, size_t >
scope: avro::concepts::NameIndexConcept< MultiAttribute< std::string > >
definition:
typedef std::map<std::string, size_t> avro::concepts::NameIndexConcept< MultiAttribute< std::string > >::IndexMap


refid: af492506c65831ff8eb7304fa269b696d
name: nameAttribute_
type: NameConcept
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
NameConcept avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::nameAttribute_


refid: aaf1c70fc8f8be7b5b92cbc68f1d0f7fd
name: leafAttributes_
type: LeavesConcept
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
LeavesConcept avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::leafAttributes_


refid: a076537be38eee3f73e956bdcac4a2bfe
name: leafNameAttributes_
type: LeafNamesConcept
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
LeafNamesConcept avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::leafNameAttributes_


refid: af04852f4148cd449f5f62bbf9478ed16
name: sizeAttribute_
type: SizeConcept
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
SizeConcept avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::sizeAttribute_


refid: a52cf5a891e7c6040e255e8180fc7e59a
name: nameIndex_
type: concepts::NameIndexConcept< LeafNamesConcept >
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
concepts::NameIndexConcept<LeafNamesConcept> avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::nameIndex_


refid: aea4e6a6c12b7748f0d2662c627c90a07
name: NodeImpl
definition: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::NodeImpl
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
argsstring:
(Type type, const NameConcept &name, const LeavesConcept &leaves, const LeafNamesConcept &leafNames, const SizeConcept &size)


refid: af452eb8e63ab41d97b37ac6f2cef80d7
name: nameAt
type: const std::string &
argsstring: (int index) const
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
const std::string& avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::nameAt


refid: a45fe79b548c4d8b1c9d0b8ff33d684e1
name: furtherResolution
type: SchemaResolution
argsstring: (const Node &reader) const
scope: avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >
definition:
SchemaResolution avro::NodeImpl< NameConcept, LeavesConcept, LeafNamesConcept, SizeConcept >::furtherResolution


refid: af766bbca52977ff72be595eb67e09d84
name: NodeRecord
definition: avro::NodeRecord::NodeRecord
scope: avro::NodeRecord
argsstring:
(const HasName &name, const MultiLeaves &fields, const LeafNames &fieldsNames, const std::vector< GenericDatum > &dv)


refid: a257177c7b0f2e98c523cb2ae68737e18
name: next
definition: virtual bool avro::OutputStream::next
type: bool
argsstring: (uint8_t **data, size_t *len)=0
scope: avro::OutputStream
briefdescription: Returns a buffer that can be written into.
detaileddescription:
On successful return, data has the pointer to the buffer
and len has the number of bytes available at data.


refid: ab799b7bad4c75b5ade65fa6fd117a4b4
name: byteCount
definition: virtual uint64_t avro::OutputStream::byteCount
type: uint64_t
argsstring: () const =0
scope: avro::OutputStream
briefdescription: Number of bytes written so far into this stream.
detaileddescription:
 The whole buffer
returned by next() is assumed to be written unless some of
it was retutned using backup().


refid: a5a07137b2c4e560036e3b87790c9421b
name: fieldOrder
definition: virtual const std::vector<size_t>& avro::ResolvingDecoder::fieldOrder
type: const std::vector< size_t > &
argsstring: ()=0
scope: avro::ResolvingDecoder
briefdescription: Returns the order of fields for records.
detaileddescription:
The order of fields could be different from the order of their
order in the schema because the writer's field order could
be different. In order to avoid buffering and later use,
we return the values in the writer's field order.  


refid: afac45d280b253381efc5f489b86c641f
name: ValidSchema
definition: class AVRO_DECL avro::ValidSchema
type: class AVRO_DECL
scope: avro
briefdescription: This class is used to implement an avro spec parser using a flex/bison compiler.
detaileddescription:
  In order for the lexer to be reentrant, this class provides a
lexer object for each parse.  The bison parser also uses this class to
build up an avro parse tree as the avro spec is parsed.  


refid: a9408498d77f42a536074433cc541d8ae
name: validatingDecoder
definition: AVRO_DECL DecoderPtr avro::validatingDecoder
type: AVRO_DECL DecoderPtr
argsstring: (const ValidSchema &schema, const DecoderPtr &base)
scope: avro
briefdescription:
Returns an decoder that validates sequence of calls to an underlying
Decoder against the given schema.


refid: aeef8b583abe36b25a8d2094d7a3d4b96
name: resolvingDecoder
definition: AVRO_DECL ResolvingDecoderPtr avro::resolvingDecoder
type: AVRO_DECL ResolvingDecoderPtr
argsstring: (const ValidSchema &writer, const ValidSchema &reader, const DecoderPtr &base)
scope: avro
detaileddescription:
The client uses the decoder as if the data were written using readerSchema.
// FIXME: Handle out of order fields.

briefdescription:
Returns a decoder that decodes avro data from base written according to
writerSchema and resolves against readerSchema.


refid: a1ba750d980390623baeae24bc24b286e
name: validatingEncoder
definition: AVRO_DECL EncoderPtr avro::validatingEncoder
type: AVRO_DECL EncoderPtr
argsstring: (const ValidSchema &schema, const EncoderPtr &base)
scope: avro
briefdescription:
Returns an encoder that validates sequence of calls to an underlying
Encoder against the given schema.


refid: a0ccce9f2136f59050dd9b866130fb052
name: memoryInputStream
definition: AVRO_DECL std::auto_ptr<InputStream> avro::memoryInputStream
type: AVRO_DECL std::auto_ptr< InputStream >
argsstring: (const OutputStream &source)
scope: avro
briefdescription: Returns a new InputStream with the contents written into an outputstream.
detaileddescription:
 The output stream must have been returned by
an earlier call to memoryOutputStream(). The contents for the new
input stream are the snapshot of the outputstream. One can construct
any number of memory input stream from a single memory output stream.


refid: a49f045f7aa22d1b628aa0fec12f82332
name: fileOutputStream
definition: AVRO_DECL std::auto_ptr<OutputStream> avro::fileOutputStream
type: AVRO_DECL std::auto_ptr< OutputStream >
argsstring: (const char *filename, size_t bufferSize=8 *1024)
scope: avro
briefdescription: Returns a new OutputStream whose contents would be stored in a file.
detaileddescription:
Data is written in chunks of given buffer size.

If there is a file with the given name, it is truncated and overwritten.
If there is no file with the given name, it is created.


refid: a0903907d3254fe1a1a018f4da4ceb04a
name: DEFINE_PRIMITIVE
initializer:
template <> \
struct is_serializable<CTYPE> : public boost::true_type{}; \
\
template <> \
struct type_to_avro<CTYPE> { \
    static const Type type = AVROTYPE; \
};


refid: abc1278d9faa11991322c707e75a92594
name: DEFINE_PROMOTABLE_PRIMITIVE
initializer:
template <> \
struct is_promotable<CTYPE> : public boost::true_type{}; \
\
DEFINE_PRIMITIVE(CTYPE, AVROTYPE)


