rust/flexbuffers/src/builder/vector.rs

// Copyright 2019 Google LLC
//
// Licensed 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.

use super::{Builder, MapBuilder, Pushable};

/// Builds a Flexbuffer vector, returned by a [Builder](struct.Builder.html).
///
/// ## Side effect when dropped:
/// When this is dropped, or `end_vector` is called, the vector is
/// commited to the buffer. If this vector is the root of the flexbuffer, then the
/// root is written and the flexbuffer is complete. The FlexBufferType of this vector
/// is determined by the pushed values when this is dropped. The most compact vector type is
/// automatically chosen.
pub struct VectorBuilder<'a> {
    pub(crate) builder: &'a mut Builder,
    // If the root is this vector then start == None. Otherwise start is the
    // number of values in the 'values stack' before adding this vector.
    pub(crate) start: Option<usize>,
}
impl<'a> VectorBuilder<'a> {
    /// Pushes `p` onto the vector.
    #[inline]
    pub fn push<P: Pushable>(&mut self, p: P) {
        self.builder.push(p);
    }
    /// Starts a nested vector that will be pushed onto this vector when it is dropped.
    #[inline]
    pub fn start_vector(&mut self) -> VectorBuilder<'_> {
        let start = Some(self.builder.values.len());
        VectorBuilder { builder: self.builder, start }
    }
    /// Starts a nested map that will be pushed onto this vector when it is dropped.
    #[inline]
    pub fn start_map(&mut self) -> MapBuilder<'_> {
        let start = Some(self.builder.values.len());
        MapBuilder { builder: self.builder, start }
    }
    /// `end_vector` determines the type of the vector and writes it to the buffer.
    /// This will happen automatically if the VectorBuilder is dropped.
    #[inline]
    pub fn end_vector(self) {}
}
impl<'a> Drop for VectorBuilder<'a> {
    #[inline]
    fn drop(&mut self) {
        self.builder.end_map_or_vector(false, self.start);
    }
}