var searchIndex = {};
searchIndex["flatbuffers"] = {"doc":"Rust support for Flatbuffers.","items":[[3,"Builder","flatbuffers","Builder provides functions to build Flatbuffer data.",null,null],[3,"Table","","Table provides functions to read Flatbuffer data.",null,null],[3,"Iterator","","An iterator over flatbuffer vectors.",null,null],[11,"clone","","",0,null],[11,"fmt","","",0,null],[11,"with_capacity","","Start a new FlatBuffer `Builder` backed by a buffer with an\ninitial capacity of `size`.",0,{"inputs":[{"name":"usize"}],"output":{"name":"self"}}],[11,"start_object","","Start encoding a new object in the buffer.",0,null],[11,"end_object","","finish off writing the object that is under construction.",0,null],[11,"read_object","","Read a completed object at offset.",0,null],[11,"read_table","","Read a completed object at offset.",0,null],[11,"start_vector","","Initializes bookkeeping for writing a new vector.",0,null],[11,"end_vector","","finish off writing the current vector.",0,null],[11,"create_string","","Create a string in the buffer from an already encoded UTF-8 `String`.",0,null],[11,"create_vector","","Create a vector in the buffer from an already encoded\nbyte vector.",0,null],[11,"create_uoffset_vector","","Create a vector of `UOffsetT` in the buffer.\nThis function will encode the values to `LittleEndian`.",0,null],[11,"finish_table","","Finalize a table, pointing to the given `root_table`.",0,null],[11,"get_bytes","","Get a reference to the underlying buffer.\nBuffer starts from the first byte of useful data\ni.e. `&[pos..]`.",0,null],[11,"swap_out","","Returns the current buffer and replaces it with\na `new_buffer`.",0,null],[11,"reset","","Resets the builder.",0,null],[11,"len","","Returns the length of the buffer.",0,null],[11,"offset","","Offset relative to the end of the buffer.",0,null],[11,"pos","","Returns the offset relative to the beggining\nof the buffer.",0,null],[11,"prep","","prepare to write an element of `size` after `additional_bytes`\nhave been written.",0,null],[11,"pad","","pad places zeros at the current offset.",0,null],[11,"put_bool","","Add a `bool` to the buffer, backwards from the current location.\nDoesn't align nor check for space.",0,null],[11,"put_u8","","Add a `byte` to the buffer, backwards from the current location.\nDoesn't align nor check for space.",0,null],[11,"put_i8","","Add a `value` of type `i8` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_u16","","Add a `value` of type `u16` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_i16","","Add a `value` of type `i16` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_u32","","Add a `value` of type `u32` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_i32","","Add a `value` of type `i32` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_u64","","Add a `value` of type `u64` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_i64","","Add a `value` of type `i64` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_f32","","Add a `value` of type `f32` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_f64","","Add a `value` of type `f64` to the buffer, backwards from the current\nlocation. Doesn't align nor check for space.",0,null],[11,"put_uoffset","","Add a `value` of type `UOffsetT` to the buffer, backwards from the\ncurrent location. Doesn't align nor check for space.",0,null],[11,"add_bool","","Add a `bool` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_u8","","Add a value of type `u8` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_i8","","Add a value of type `i8` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_u16","","Add a value of type `u16` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_i16","","Add a value of type `i16` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_u32","","Add a value of type `u32` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_i32","","Add a value of type `i32` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_u64","","Add a value of type `u64` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_i64","","Add a value of type `i64` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_f32","","Add a value of type `f32` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_f64","","Add a value of type `f64` to the buffer, properly aligned, and grows the\nbuffer (if necessary).",0,null],[11,"add_uoffset","","Add a value of type `f64` to the buffer, properly aligned, and grows the\nbuffer (if necessary).\nprepends an UOffsetT, relative to where it will be written.",0,null],[11,"slot","","Slot sets the vtable key `voffset` to the current location in the buffer.",0,null],[11,"add_slot_bool","","Add a `bool` onto the object at vtable slot `o`. If value `x` equals\ndefault `d`, then the slot will be set to zero and no other data\nwill be written.",0,null],[11,"add_slot_u8","","Add a value of type `u8` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_i8","","Add a value of type `i8` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_u16","","Add a value of type `u16` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_i16","","Add a value of type `i16` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_u32","","Add a value of type `u32` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_i32","","Add a value of type `i32` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_u64","","Add a value of type `u64` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_i64","","Add a value of type `i64` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_f32","","Add a value of type `f32` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_f64","","Add a value of type `f64` onto the object at vtable slot `o`. If value\n`x` equals default `d`, then the slot will be set to zero and no other\ndata will be written.",0,null],[11,"add_slot_uoffset","","Add a value of type `UOffsetT` onto the object at vtable slot `o`. If\nvalue `x` equals default `d`, then the slot will be set to zero and no\nother data will be written.",0,null],[11,"add_slot_struct","","PrependStructSlot prepends a struct onto the object at vtable slot `o`.\nStructs are stored inline, so nothing additional is being added.\nIn generated code, `d` is always 0.",0,null],[11,"place_u8","","Place a `u8` at `pos` relative to the beginning\nof the underlaying buffer.",0,null],[11,"place_u32","","Place a `u32` with `LittleEndian` encoding at `pos`\nrelative to the beginning of the underlaying buffer.",0,null],[11,"place_i32","","Place a `i32` with `LittleEndian` encoding at `pos`\nrelative to the beginning of the underlaying buffer.",0,null],[11,"place_u64","","Place a `u64` with `LittleEndian` encoding at `pos`\nrelative to the beginning of the underlaying buffer.",0,null],[11,"assert_not_finished","","Check to assert `finish` has not been called.",0,null],[11,"assert_not_nested","","Check to assert `start_object` has not been called.",0,null],[11,"assert_nested","","Check to assert `start_object` has been called.",0,null],[11,"get_u16","","Helper method to read a VOffsetT at `pos` relative to the\nbeginning of the underlying buffer - this may not be the start\nof any useful data. Use with `offset()` to get the `UOffsetT`\nof useful data.",0,null],[11,"get_32","","Helper method to read a UOffsetT at `pos` relative to the\nbeginning of the underlying buffer - this may not be the start\nof any useful data. Use with `offset()` to get the `UOffsetT`\nof useful data.",0,null],[11,"grow","","Doubles the size of the buffer.",0,null],[11,"default","","",0,{"inputs":[],"output":{"name":"builder"}}],[11,"into","","",0,null],[11,"eq","","",1,null],[11,"ne","","",1,null],[11,"clone","","",1,null],[11,"fmt","","",1,null],[11,"from_offset","","Create a table using from a slice using data starting at `pos`.\nFirst `UOffsetT` should indicate the offset from the root\nof the table to the begining of the object.",1,null],[11,"with_pos","","Create a table for an object.\n`pos` should be the offset to the first byte of\nuseable data.",1,null],[11,"get_root","","Return an object table at offset.\nSee `from_offset`.",1,null],[11,"get_indirect_root","","Return an object table at offset specified by offset.",1,null],[11,"field_offset","","Returns the field offset or 0 if the field was not present.",1,null],[11,"get_slot_bool","","Returns the `bool` value of the field at the offset written in the\nvtable `slot`. ",1,null],[11,"get_slot_u8","","Returns the `u8` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_i8","","Returns the `i8` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_u16","","Returns the `u16` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_i16","","Returns the `i16` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_u32","","Returns the `u32` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_i32","","Returns the `i32` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_u64","","Returns the `u64` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_i64","","Returns the `i64` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_f32","","Returns the `f32` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_f64","","Returns the `f64` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_str","","Returns the `&str` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_struct","","Returns the struct `T` value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_slot_vector","","Returns the unsigned byte vector value of the field at the offset written in the\nvtable `slot`.",1,null],[11,"get_vector","","ByteVector gets an unsigned byte slice from data stored inside\nthe flatbuffer.",1,null],[11,"get_bool","","Returns a value of `bool` at `offset`.",1,null],[11,"get_u8","","Returns a value of `u8` at `offset`.",1,null],[11,"get_i8","","Returns a value of `i8` at `offset`.",1,null],[11,"get_u16","","Returns a value of `u16` at `offset`.",1,null],[11,"get_i16","","Returns a value of `i16` at `offset`.",1,null],[11,"get_u32","","Returns a value of `u32` at `offset`.",1,null],[11,"get_i32","","Returns a value of `i32` at `offset`.",1,null],[11,"get_u64","","Returns a value of `u64` at `offset`.",1,null],[11,"get_i64","","Returns a value of `i64` at `offset`.",1,null],[11,"get_f32","","Returns a value of `f32` at `offset`.",1,null],[11,"get_f64","","Returns a value of `f64` at `offset`.",1,null],[11,"get_str","","Returns a value of `&str` at `offset`.",1,null],[11,"get_struct","","Retrieve a struct table from offset. Offset should point to then\nfirst usable byte of data i.e. the Vtable offset.",1,null],[11,"get_pos","","Accesor function for the tables position in the buffer.",1,null],[11,"read_uoffset","","Reads an `UOffsetT` at exact position.",1,null],[11,"read_voffset","","Reads an `VOffsetT` at exact position.",1,null],[11,"read_voffset_slot","","Retrieves the `VOffsetT` in the vtable `slot`.\nIf the vtable value is zero, the default value `d` will be returned.",1,null],[11,"get_bytes","","Get a reference to the raw buffer",1,null],[11,"from","","",1,null],[11,"fmt","","",2,null],[11,"next","","",2,null],[11,"len","","",2,null],[11,"default","","",2,{"inputs":[],"output":{"name":"iterator"}}],[11,"new","","Create a new Iterator for type `T` starting at `index` with\na length of `len` items of size `T`.",2,null],[0,"macros","","TODO",null,null],[6,"UOffsetT","","A UOffsetT stores an unsigned offset into vector data.",null,null],[6,"VOffsetT","","A VOffsetT stores an unsigned offset in a vtable.",null,null],[6,"SOffsetT","","A SOffsetT stores a signed offset into arbitrary data.",null,null],[8,"VectorItem","","A trait for Structs and Tables to implement.",null,null],[10,"indirect_lookup","","Table Objects require indirection. Structs do not.",3,{"inputs":[],"output":{"name":"bool"}}],[10,"inline_size","","The size of the object in the vector.",3,{"inputs":[],"output":{"name":"usize"}}],[8,"LittleEndianReader","","A trait for handling little endian encoding of byte arrays.",null,null],[10,"read","","Read the first byte from buffer and return type `Self`.",4,null],[10,"size","","Provide the size in bytes of type `Self`.",4,{"inputs":[],"output":{"name":"usize"}}],[14,"table_fn!","","",null,null],[14,"struct_fn!","","",null,null],[14,"table_get_fn!","","",null,null],[14,"struct_get_fn!","","",null,null],[14,"table_struct!","","",null,null],[14,"vector_item!","","",null,null],[14,"table_object!","","",null,null],[14,"struct_object!","","",null,null],[14,"simple_enum!","","",null,null],[14,"union!","","",null,null]],"paths":[[3,"Builder"],[3,"Table"],[3,"Iterator"],[8,"VectorItem"],[8,"LittleEndianReader"]]};
initSearch(searchIndex);