swift/Sources/FlatBuffers/FlatBufferObject.swift

   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 import Foundation
  18
  19 /// NativeStruct is a protocol that indicates if the struct is a native `swift` struct
  20 /// since now we will be serializing native structs into the buffer.
  21 public protocol NativeStruct {}
  22
  23 /// FlatbufferObject structures all the Flatbuffers objects
  24 public protocol FlatBufferObject {
  25   var __buffer: ByteBuffer! { get }
  26   init(_ bb: ByteBuffer, o: Int32)
  27 }
  28
  29 public protocol ObjectAPIPacker {
  30   associatedtype T
  31   static func pack(_ builder: inout FlatBufferBuilder, obj: inout T) -> Offset<UOffset>
  32   mutating func unpack() -> T
  33 }
  34
  35 public protocol Enum {
  36   associatedtype T: Scalar
  37   static var byteSize: Int { get }
  38   var value: T { get }
  39 }