xref: /aosp_15_r20/external/flatbuffers/swift/Sources/FlatBuffers/FlatBuffersUtils.swift (revision 890232f25432b36107d06881e0a25aaa6b473652)
1 /*
2  * Copyright 2021 Google Inc. All rights reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #if !os(WASI)
18 import Foundation
19 #else
20 import SwiftOverlayShims
21 #endif
22 
23 /// FlatBuffersUtils hosts some utility functions that might be useful
24 public enum FlatBuffersUtils {
25 
26   /// Gets the size of the prefix
27   /// - Parameter bb: Flatbuffer object
getSizePrefixnull28   public static func getSizePrefix(bb: ByteBuffer) -> Int32 {
29     bb.read(def: Int32.self, position: bb.reader)
30   }
31 
32   /// Removes the prefix by duplicating the Flatbuffer this call is expensive since its
33   /// creates a new buffer use `readPrefixedSizeCheckedRoot` instead
34   /// unless a completely new buffer is required
35   /// - Parameter bb: Flatbuffer object
36   ///
37   ///
removeSizePrefixnull38   public static func removeSizePrefix(bb: ByteBuffer) -> ByteBuffer {
39     bb.duplicate(removing: MemoryLayout<Int32>.size)
40   }
41 }
42