1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
/* * Copyright 2020 Google Inc. All rights reserved. * * 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 * * http://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 crate::{ Follow, ForwardsUOffset, InvalidFlatbuffer, SkipSizePrefix, Verifiable, Verifier, VerifierOptions, }; /// Gets the root of the Flatbuffer, verifying it first with default options. /// Note that verification is an experimental feature and may not be maximally performant or /// catch every error (though that is the goal). See the `_unchecked` variants for previous /// behavior. pub fn root<'buf, T>(data: &'buf [u8]) -> Result<T::Inner, InvalidFlatbuffer> where T: 'buf + Follow<'buf> + Verifiable, { let opts = VerifierOptions::default(); root_with_opts::<T>(&opts, data) } #[inline] /// Gets the root of the Flatbuffer, verifying it first with given options. /// Note that verification is an experimental feature and may not be maximally performant or /// catch every error (though that is the goal). See the `_unchecked` variants for previous /// behavior. pub fn root_with_opts<'opts, 'buf, T>( opts: &'opts VerifierOptions, data: &'buf [u8], ) -> Result<T::Inner, InvalidFlatbuffer> where T: 'buf + Follow<'buf> + Verifiable, { let mut v = Verifier::new(&opts, data); <ForwardsUOffset<T>>::run_verifier(&mut v, 0)?; Ok(unsafe { root_unchecked::<T>(data) }) } #[inline] /// Gets the root of a size prefixed Flatbuffer, verifying it first with default options. /// Note that verification is an experimental feature and may not be maximally performant or /// catch every error (though that is the goal). See the `_unchecked` variants for previous /// behavior. pub fn size_prefixed_root<'buf, T>(data: &'buf [u8]) -> Result<T::Inner, InvalidFlatbuffer> where T: 'buf + Follow<'buf> + Verifiable, { let opts = VerifierOptions::default(); size_prefixed_root_with_opts::<T>(&opts, data) } #[inline] /// Gets the root of a size prefixed Flatbuffer, verifying it first with given options. /// Note that verification is an experimental feature and may not be maximally performant or /// catch every error (though that is the goal). See the `_unchecked` variants for previous /// behavior. pub fn size_prefixed_root_with_opts<'opts, 'buf, T>( opts: &'opts VerifierOptions, data: &'buf [u8], ) -> Result<T::Inner, InvalidFlatbuffer> where T: 'buf + Follow<'buf> + Verifiable, { let mut v = Verifier::new(&opts, data); <SkipSizePrefix<ForwardsUOffset<T>>>::run_verifier(&mut v, 0)?; Ok(unsafe { size_prefixed_root_unchecked::<T>(data) }) } #[inline] /// Gets root for a trusted Flatbuffer. /// # Safety /// Flatbuffers accessors do not perform validation checks before accessing. Unlike the other /// `root` functions, this does not validate the flatbuffer before returning the accessor. Users /// must trust `data` contains a valid flatbuffer (e.g. b/c it was built by your software). Reading /// unchecked buffers may cause panics or even UB. pub unsafe fn root_unchecked<'buf, T>(data: &'buf [u8]) -> T::Inner where T: Follow<'buf> + 'buf, { <ForwardsUOffset<T>>::follow(data, 0) } #[inline] /// Gets root for a trusted, size prefixed, Flatbuffer. /// # Safety /// Flatbuffers accessors do not perform validation checks before accessing. Unlike the other /// `root` functions, this does not validate the flatbuffer before returning the accessor. Users /// must trust `data` contains a valid flatbuffer (e.g. b/c it was built by your software). Reading /// unchecked buffers may cause panics or even UB. pub unsafe fn size_prefixed_root_unchecked<'buf, T>(data: &'buf [u8]) -> T::Inner where T: Follow<'buf> + 'buf, { <SkipSizePrefix<ForwardsUOffset<T>>>::follow(data, 0) }