• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2024 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 import Foundation
18 
19 /// Struct is a representation of a mutable `Flatbuffers` struct
20 /// since native structs are value types and cant be mutated
21 @frozen
22 public struct Struct {
23 
24   /// Hosting Bytebuffer
25   public private(set) var bb: ByteBuffer
26   /// Current position of the struct
27   public private(set) var position: Int32
28 
29   /// Initializer for a mutable flatbuffers struct
30   /// - Parameters:
31   ///   - bb: Current hosting Bytebuffer
32   ///   - position: Current position for the struct in the ByteBuffer
33   public init(bb: ByteBuffer, position: Int32 = 0) {
34     self.bb = bb
35     self.position = position
36   }
37 
38   /// Reads data from the buffer directly at offset O
39   /// - Parameters:
40   ///   - type: Type of data to be read
41   ///   - o: Current offset of the data
42   /// - Returns: Data of Type T that conforms to type Scalar
readBuffer<T: Scalar>null43   public func readBuffer<T: Scalar>(of type: T.Type, at o: Int32) -> T {
44     let r = bb.read(def: T.self, position: Int(o + position))
45     return r
46   }
47 }
48