pub struct Map<'a> {
pub _tab: Table<'a>,
}
Expand description
A Map is a logical nested type that is represented as
List<entries: Struct<key: K, value: V>>
In this layout, the keys and values are each respectively contiguous. We do not constrain the key and value types, so the application is responsible for ensuring that the keys are hashable and unique. Whether the keys are sorted may be set in the metadata for this field.
In a field with Map type, the field has a child Struct field, which then has two children: key type and the second the value type. The names of the child fields may be respectively “entries”, “key”, and “value”, but this is not enforced.
Map
- child[0] entries: Struct
- child[0] key: K
- child[1] value: V
Neither the “entries” field nor the “key” field may be nullable.
The metadata is structured so that Arrow systems without special handling for Map can make Map an alias for List. The “layout” attribute for the Map field must have the same contents as a List.
Fields
_tab: Table<'a>
Implementations
sourceimpl<'a> Map<'a>
impl<'a> Map<'a>
pub fn init_from_table(table: Table<'a>) -> Self
pub fn create<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>(
_fbb: &'mut_bldr mut FlatBufferBuilder<'bldr>,
args: &'args MapArgs
) -> WIPOffset<Map<'bldr>>
pub const VT_KEYSSORTED: VOffsetT = 4u16
sourcepub fn keysSorted(&self) -> bool
pub fn keysSorted(&self) -> bool
Set to true if the keys within each value are sorted
Trait Implementations
sourceimpl Verifiable for Map<'_>
impl Verifiable for Map<'_>
sourcefn run_verifier(
v: &mut Verifier<'_, '_>,
pos: usize
) -> Result<(), InvalidFlatbuffer>
fn run_verifier(
v: &mut Verifier<'_, '_>,
pos: usize
) -> Result<(), InvalidFlatbuffer>
Runs the verifier for this type, assuming its at position pos
in the verifier’s buffer.
Should not need to be called directly. Read more
impl<'a> Copy for Map<'a>
impl<'a> StructuralPartialEq for Map<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for Map<'a>
impl<'a> Send for Map<'a>
impl<'a> Sync for Map<'a>
impl<'a> Unpin for Map<'a>
impl<'a> UnwindSafe for Map<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more