aedat 1.2.7

A fast AEDAT4 Rust implementation. Forked from https://github.com/neuromorphicsystems/aedat, a Rust AEDAT4 decoder for Python projects.
Documentation
// automatically generated by the FlatBuffers compiler, do not modify

use std::cmp::Ordering;
use std::mem;

extern crate flatbuffers;
use self::flatbuffers::{EndianScalar, Follow};

#[deprecated(
    since = "2.0.0",
    note = "Use associated constants instead. This will no longer be generated in 2021."
)]
pub const ENUM_MIN_FRAME_FORMAT: i8 = 0;
#[deprecated(
    since = "2.0.0",
    note = "Use associated constants instead. This will no longer be generated in 2021."
)]
pub const ENUM_MAX_FRAME_FORMAT: i8 = 24;
#[deprecated(
    since = "2.0.0",
    note = "Use associated constants instead. This will no longer be generated in 2021."
)]
#[allow(non_camel_case_types)]
pub const ENUM_VALUES_FRAME_FORMAT: [FrameFormat; 3] =
    [FrameFormat::Gray, FrameFormat::Bgr, FrameFormat::Bgra];

#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[repr(transparent)]
pub struct FrameFormat(pub i8);
#[allow(non_upper_case_globals)]
impl FrameFormat {
    pub const Gray: Self = Self(0);
    pub const Bgr: Self = Self(16);
    pub const Bgra: Self = Self(24);

    pub const ENUM_MIN: i8 = 0;
    pub const ENUM_MAX: i8 = 24;
    pub const ENUM_VALUES: &'static [Self] = &[Self::Gray, Self::Bgr, Self::Bgra];
    /// Returns the variant's name or "" if unknown.
    pub fn variant_name(self) -> Option<&'static str> {
        match self {
            Self::Gray => Some("Gray"),
            Self::Bgr => Some("Bgr"),
            Self::Bgra => Some("Bgra"),
            _ => None,
        }
    }
}
impl std::fmt::Debug for FrameFormat {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        if let Some(name) = self.variant_name() {
            f.write_str(name)
        } else {
            f.write_fmt(format_args!("<UNKNOWN {:?}>", self.0))
        }
    }
}
impl<'a> flatbuffers::Follow<'a> for FrameFormat {
    type Inner = Self;
    #[inline]
    fn follow(buf: &'a [u8], loc: usize) -> Self::Inner {
        let b = unsafe { flatbuffers::read_scalar_at::<i8>(buf, loc) };
        Self(b)
    }
}

impl flatbuffers::Push for FrameFormat {
    type Output = FrameFormat;
    #[inline]
    fn push(&self, dst: &mut [u8], _rest: &[u8]) {
        unsafe {
            flatbuffers::emplace_scalar::<i8>(dst, self.0);
        }
    }
}

impl flatbuffers::EndianScalar for FrameFormat {
    #[inline]
    fn to_little_endian(self) -> Self {
        let b = i8::to_le(self.0);
        Self(b)
    }
    #[inline]
    #[allow(clippy::wrong_self_convention)]
    fn from_little_endian(self) -> Self {
        let b = i8::from_le(self.0);
        Self(b)
    }
}

impl<'a> flatbuffers::Verifiable for FrameFormat {
    #[inline]
    fn run_verifier(
        v: &mut flatbuffers::Verifier,
        pos: usize,
    ) -> Result<(), flatbuffers::InvalidFlatbuffer> {
        use self::flatbuffers::Verifiable;
        i8::run_verifier(v, pos)
    }
}

impl flatbuffers::SimpleToVerifyInSlice for FrameFormat {}
pub enum FrameOffset {}
#[derive(Copy, Clone, PartialEq)]

pub struct Frame<'a> {
    pub _tab: flatbuffers::Table<'a>,
}

impl<'a> flatbuffers::Follow<'a> for Frame<'a> {
    type Inner = Frame<'a>;
    #[inline]
    fn follow(buf: &'a [u8], loc: usize) -> Self::Inner {
        Self {
            _tab: flatbuffers::Table { buf, loc },
        }
    }
}

impl<'a> Frame<'a> {
    #[inline]
    pub fn init_from_table(table: flatbuffers::Table<'a>) -> Self {
        Frame { _tab: table }
    }
    #[allow(unused_mut)]
    pub fn create<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>(
        _fbb: &'mut_bldr mut flatbuffers::FlatBufferBuilder<'bldr>,
        args: &'args FrameArgs<'args>,
    ) -> flatbuffers::WIPOffset<Frame<'bldr>> {
        let mut builder = FrameBuilder::new(_fbb);
        builder.add_exposure_end_t(args.exposure_end_t);
        builder.add_exposure_begin_t(args.exposure_begin_t);
        builder.add_end_t(args.end_t);
        builder.add_begin_t(args.begin_t);
        builder.add_t(args.t);
        if let Some(x) = args.pixels {
            builder.add_pixels(x);
        }
        builder.add_offset_y(args.offset_y);
        builder.add_offset_x(args.offset_x);
        builder.add_height(args.height);
        builder.add_width(args.width);
        builder.add_format(args.format);
        builder.finish()
    }

    pub const VT_T: flatbuffers::VOffsetT = 4;
    pub const VT_BEGIN_T: flatbuffers::VOffsetT = 6;
    pub const VT_END_T: flatbuffers::VOffsetT = 8;
    pub const VT_EXPOSURE_BEGIN_T: flatbuffers::VOffsetT = 10;
    pub const VT_EXPOSURE_END_T: flatbuffers::VOffsetT = 12;
    pub const VT_FORMAT: flatbuffers::VOffsetT = 14;
    pub const VT_WIDTH: flatbuffers::VOffsetT = 16;
    pub const VT_HEIGHT: flatbuffers::VOffsetT = 18;
    pub const VT_OFFSET_X: flatbuffers::VOffsetT = 20;
    pub const VT_OFFSET_Y: flatbuffers::VOffsetT = 22;
    pub const VT_PIXELS: flatbuffers::VOffsetT = 24;

    #[inline]
    pub fn t(&self) -> i64 {
        self._tab.get::<i64>(Frame::VT_T, Some(0)).unwrap()
    }
    #[inline]
    pub fn begin_t(&self) -> i64 {
        self._tab.get::<i64>(Frame::VT_BEGIN_T, Some(0)).unwrap()
    }
    #[inline]
    pub fn end_t(&self) -> i64 {
        self._tab.get::<i64>(Frame::VT_END_T, Some(0)).unwrap()
    }
    #[inline]
    pub fn exposure_begin_t(&self) -> i64 {
        self._tab
            .get::<i64>(Frame::VT_EXPOSURE_BEGIN_T, Some(0))
            .unwrap()
    }
    #[inline]
    pub fn exposure_end_t(&self) -> i64 {
        self._tab
            .get::<i64>(Frame::VT_EXPOSURE_END_T, Some(0))
            .unwrap()
    }
    #[inline]
    pub fn format(&self) -> FrameFormat {
        self._tab
            .get::<FrameFormat>(Frame::VT_FORMAT, Some(FrameFormat::Gray))
            .unwrap()
    }
    #[inline]
    pub fn width(&self) -> i16 {
        self._tab.get::<i16>(Frame::VT_WIDTH, Some(0)).unwrap()
    }
    #[inline]
    pub fn height(&self) -> i16 {
        self._tab.get::<i16>(Frame::VT_HEIGHT, Some(0)).unwrap()
    }
    #[inline]
    pub fn offset_x(&self) -> i16 {
        self._tab.get::<i16>(Frame::VT_OFFSET_X, Some(0)).unwrap()
    }
    #[inline]
    pub fn offset_y(&self) -> i16 {
        self._tab.get::<i16>(Frame::VT_OFFSET_Y, Some(0)).unwrap()
    }
    #[inline]
    pub fn pixels(&self) -> Option<&'a [u8]> {
        self._tab
            .get::<flatbuffers::ForwardsUOffset<flatbuffers::Vector<'a, u8>>>(
                Frame::VT_PIXELS,
                None,
            )
            .map(|v| v.safe_slice())
    }
}

impl flatbuffers::Verifiable for Frame<'_> {
    #[inline]
    fn run_verifier(
        v: &mut flatbuffers::Verifier,
        pos: usize,
    ) -> Result<(), flatbuffers::InvalidFlatbuffer> {
        use self::flatbuffers::Verifiable;
        v.visit_table(pos)?
            .visit_field::<i64>(&"t", Self::VT_T, false)?
            .visit_field::<i64>(&"begin_t", Self::VT_BEGIN_T, false)?
            .visit_field::<i64>(&"end_t", Self::VT_END_T, false)?
            .visit_field::<i64>(&"exposure_begin_t", Self::VT_EXPOSURE_BEGIN_T, false)?
            .visit_field::<i64>(&"exposure_end_t", Self::VT_EXPOSURE_END_T, false)?
            .visit_field::<FrameFormat>(&"format", Self::VT_FORMAT, false)?
            .visit_field::<i16>(&"width", Self::VT_WIDTH, false)?
            .visit_field::<i16>(&"height", Self::VT_HEIGHT, false)?
            .visit_field::<i16>(&"offset_x", Self::VT_OFFSET_X, false)?
            .visit_field::<i16>(&"offset_y", Self::VT_OFFSET_Y, false)?
            .visit_field::<flatbuffers::ForwardsUOffset<flatbuffers::Vector<'_, u8>>>(
                &"pixels",
                Self::VT_PIXELS,
                false,
            )?
            .finish();
        Ok(())
    }
}
pub struct FrameArgs<'a> {
    pub t: i64,
    pub begin_t: i64,
    pub end_t: i64,
    pub exposure_begin_t: i64,
    pub exposure_end_t: i64,
    pub format: FrameFormat,
    pub width: i16,
    pub height: i16,
    pub offset_x: i16,
    pub offset_y: i16,
    pub pixels: Option<flatbuffers::WIPOffset<flatbuffers::Vector<'a, u8>>>,
}
impl<'a> Default for FrameArgs<'a> {
    #[inline]
    fn default() -> Self {
        FrameArgs {
            t: 0,
            begin_t: 0,
            end_t: 0,
            exposure_begin_t: 0,
            exposure_end_t: 0,
            format: FrameFormat::Gray,
            width: 0,
            height: 0,
            offset_x: 0,
            offset_y: 0,
            pixels: None,
        }
    }
}
pub struct FrameBuilder<'a: 'b, 'b> {
    fbb_: &'b mut flatbuffers::FlatBufferBuilder<'a>,
    start_: flatbuffers::WIPOffset<flatbuffers::TableUnfinishedWIPOffset>,
}
impl<'a: 'b, 'b> FrameBuilder<'a, 'b> {
    #[inline]
    pub fn add_t(&mut self, t: i64) {
        self.fbb_.push_slot::<i64>(Frame::VT_T, t, 0);
    }
    #[inline]
    pub fn add_begin_t(&mut self, begin_t: i64) {
        self.fbb_.push_slot::<i64>(Frame::VT_BEGIN_T, begin_t, 0);
    }
    #[inline]
    pub fn add_end_t(&mut self, end_t: i64) {
        self.fbb_.push_slot::<i64>(Frame::VT_END_T, end_t, 0);
    }
    #[inline]
    pub fn add_exposure_begin_t(&mut self, exposure_begin_t: i64) {
        self.fbb_
            .push_slot::<i64>(Frame::VT_EXPOSURE_BEGIN_T, exposure_begin_t, 0);
    }
    #[inline]
    pub fn add_exposure_end_t(&mut self, exposure_end_t: i64) {
        self.fbb_
            .push_slot::<i64>(Frame::VT_EXPOSURE_END_T, exposure_end_t, 0);
    }
    #[inline]
    pub fn add_format(&mut self, format: FrameFormat) {
        self.fbb_
            .push_slot::<FrameFormat>(Frame::VT_FORMAT, format, FrameFormat::Gray);
    }
    #[inline]
    pub fn add_width(&mut self, width: i16) {
        self.fbb_.push_slot::<i16>(Frame::VT_WIDTH, width, 0);
    }
    #[inline]
    pub fn add_height(&mut self, height: i16) {
        self.fbb_.push_slot::<i16>(Frame::VT_HEIGHT, height, 0);
    }
    #[inline]
    pub fn add_offset_x(&mut self, offset_x: i16) {
        self.fbb_.push_slot::<i16>(Frame::VT_OFFSET_X, offset_x, 0);
    }
    #[inline]
    pub fn add_offset_y(&mut self, offset_y: i16) {
        self.fbb_.push_slot::<i16>(Frame::VT_OFFSET_Y, offset_y, 0);
    }
    #[inline]
    pub fn add_pixels(&mut self, pixels: flatbuffers::WIPOffset<flatbuffers::Vector<'b, u8>>) {
        self.fbb_
            .push_slot_always::<flatbuffers::WIPOffset<_>>(Frame::VT_PIXELS, pixels);
    }
    #[inline]
    pub fn new(_fbb: &'b mut flatbuffers::FlatBufferBuilder<'a>) -> FrameBuilder<'a, 'b> {
        let start = _fbb.start_table();
        FrameBuilder {
            fbb_: _fbb,
            start_: start,
        }
    }
    #[inline]
    pub fn finish(self) -> flatbuffers::WIPOffset<Frame<'a>> {
        let o = self.fbb_.end_table(self.start_);
        flatbuffers::WIPOffset::new(o.value())
    }
}

impl std::fmt::Debug for Frame<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut ds = f.debug_struct("Frame");
        ds.field("t", &self.t());
        ds.field("begin_t", &self.begin_t());
        ds.field("end_t", &self.end_t());
        ds.field("exposure_begin_t", &self.exposure_begin_t());
        ds.field("exposure_end_t", &self.exposure_end_t());
        ds.field("format", &self.format());
        ds.field("width", &self.width());
        ds.field("height", &self.height());
        ds.field("offset_x", &self.offset_x());
        ds.field("offset_y", &self.offset_y());
        ds.field("pixels", &self.pixels());
        ds.finish()
    }
}
#[inline]
#[deprecated(since = "2.0.0", note = "Deprecated in favor of `root_as...` methods.")]
pub fn get_root_as_frame<'a>(buf: &'a [u8]) -> Frame<'a> {
    unsafe { flatbuffers::root_unchecked::<Frame<'a>>(buf) }
}

#[inline]
#[deprecated(since = "2.0.0", note = "Deprecated in favor of `root_as...` methods.")]
pub fn get_size_prefixed_root_as_frame<'a>(buf: &'a [u8]) -> Frame<'a> {
    unsafe { flatbuffers::size_prefixed_root_unchecked::<Frame<'a>>(buf) }
}

#[inline]
/// Verifies that a buffer of bytes contains a `Frame`
/// and returns it.
/// Note that verification is still experimental and may not
/// catch every error, or be maximally performant. For the
/// previous, unchecked, behavior use
/// `root_as_frame_unchecked`.
pub fn root_as_frame(buf: &[u8]) -> Result<Frame, flatbuffers::InvalidFlatbuffer> {
    flatbuffers::root::<Frame>(buf)
}
#[inline]
/// Verifies that a buffer of bytes contains a size prefixed
/// `Frame` and returns it.
/// Note that verification is still experimental and may not
/// catch every error, or be maximally performant. For the
/// previous, unchecked, behavior use
/// `size_prefixed_root_as_frame_unchecked`.
pub fn size_prefixed_root_as_frame(buf: &[u8]) -> Result<Frame, flatbuffers::InvalidFlatbuffer> {
    flatbuffers::size_prefixed_root::<Frame>(buf)
}
#[inline]
/// Verifies, with the given options, that a buffer of bytes
/// contains a `Frame` and returns it.
/// Note that verification is still experimental and may not
/// catch every error, or be maximally performant. For the
/// previous, unchecked, behavior use
/// `root_as_frame_unchecked`.
pub fn root_as_frame_with_opts<'b, 'o>(
    opts: &'o flatbuffers::VerifierOptions,
    buf: &'b [u8],
) -> Result<Frame<'b>, flatbuffers::InvalidFlatbuffer> {
    flatbuffers::root_with_opts::<Frame<'b>>(opts, buf)
}
#[inline]
/// Verifies, with the given verifier options, that a buffer of
/// bytes contains a size prefixed `Frame` and returns
/// it. Note that verification is still experimental and may not
/// catch every error, or be maximally performant. For the
/// previous, unchecked, behavior use
/// `root_as_frame_unchecked`.
pub fn size_prefixed_root_as_frame_with_opts<'b, 'o>(
    opts: &'o flatbuffers::VerifierOptions,
    buf: &'b [u8],
) -> Result<Frame<'b>, flatbuffers::InvalidFlatbuffer> {
    flatbuffers::size_prefixed_root_with_opts::<Frame<'b>>(opts, buf)
}
#[inline]
/// Assumes, without verification, that a buffer of bytes contains a Frame and returns it.
/// # Safety
/// Callers must trust the given bytes do indeed contain a valid `Frame`.
pub unsafe fn root_as_frame_unchecked(buf: &[u8]) -> Frame {
    flatbuffers::root_unchecked::<Frame>(buf)
}
#[inline]
/// Assumes, without verification, that a buffer of bytes contains a size prefixed Frame and returns it.
/// # Safety
/// Callers must trust the given bytes do indeed contain a valid size prefixed `Frame`.
pub unsafe fn size_prefixed_root_as_frame_unchecked(buf: &[u8]) -> Frame {
    flatbuffers::size_prefixed_root_unchecked::<Frame>(buf)
}
pub const FRAME_IDENTIFIER: &str = "FRME";

#[inline]
pub fn frame_buffer_has_identifier(buf: &[u8]) -> bool {
    flatbuffers::buffer_has_identifier(buf, FRAME_IDENTIFIER, false)
}

#[inline]
pub fn frame_size_prefixed_buffer_has_identifier(buf: &[u8]) -> bool {
    flatbuffers::buffer_has_identifier(buf, FRAME_IDENTIFIER, true)
}

#[inline]
pub fn finish_frame_buffer<'a, 'b>(
    fbb: &'b mut flatbuffers::FlatBufferBuilder<'a>,
    root: flatbuffers::WIPOffset<Frame<'a>>,
) {
    fbb.finish(root, Some(FRAME_IDENTIFIER));
}

#[inline]
pub fn finish_size_prefixed_frame_buffer<'a, 'b>(
    fbb: &'b mut flatbuffers::FlatBufferBuilder<'a>,
    root: flatbuffers::WIPOffset<Frame<'a>>,
) {
    fbb.finish_size_prefixed(root, Some(FRAME_IDENTIFIER));
}