xref: /aosp_15_r20/external/flatbuffers/swift/Sources/FlatBuffers/Struct.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 /// Struct is a representation of a mutable `Flatbuffers` struct
24 /// since native structs are value types and cant be mutated
25 @frozen
26 public struct Struct {
27 
28   /// Hosting Bytebuffer
29   public private(set) var bb: ByteBuffer
30   /// Current position of the struct
31   public private(set) var postion: Int32
32 
33   /// Initializer for a mutable flatbuffers struct
34   /// - Parameters:
35   ///   - bb: Current hosting Bytebuffer
36   ///   - position: Current position for the struct in the ByteBuffer
37   public init(bb: ByteBuffer, position: Int32 = 0) {
38     self.bb = bb
39     postion = position
40   }
41 
42   /// Reads data from the buffer directly at offset O
43   /// - Parameters:
44   ///   - type: Type of data to be read
45   ///   - o: Current offset of the data
46   /// - Returns: Data of Type T that conforms to type Scalar
readBuffer<T: Scalar>null47   public func readBuffer<T: Scalar>(of type: T.Type, at o: Int32) -> T {
48     let r = bb.read(def: T.self, position: Int(o + postion))
49     return r
50   }
51 }
52