damus

nostr ios client
git clone git://jb55.com/damus
Log | Files | Refs | README | LICENSE

FlatBufferObject.swift (2857B)

      1 /*
      2  * Copyright 2023 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 /// NativeStruct is a protocol that indicates if the struct is a native `swift` struct
     24 /// since now we will be serializing native structs into the buffer.
     25 public protocol NativeStruct {}
     26 
     27 /// FlatbuffersInitializable is a protocol that allows any object to be
     28 /// Initialized from a ByteBuffer
     29 public protocol FlatbuffersInitializable {
     30   /// Any flatbuffers object that confirms to this protocol is going to be
     31   /// initializable through this initializer
     32   init(_ bb: ByteBuffer, o: Int32)
     33 }
     34 
     35 /// FlatbufferObject structures all the Flatbuffers objects
     36 public protocol FlatBufferObject: FlatbuffersInitializable {
     37   var __buffer: ByteBuffer! { get }
     38 }
     39 
     40 /// ``ObjectAPIPacker`` is a protocol that allows object to pack and unpack from a
     41 /// ``NativeObject`` to a flatbuffers Object and vice versa.
     42 public protocol ObjectAPIPacker {
     43   /// associatedtype to the object that should be unpacked.
     44   associatedtype T
     45 
     46   /// ``pack(_:obj:)-3ptws`` tries to pacs the variables of a native Object into the `ByteBuffer` by using
     47   /// a FlatBufferBuilder
     48   /// - Parameters:
     49   ///   - builder: FlatBufferBuilder that will host incoming data
     50   ///   - obj: Object of associatedtype to the current implementer
     51   ///
     52   /// ``pack(_:obj:)-3ptws`` can be called by passing through an already initialized ``FlatBufferBuilder``
     53   /// or it can be called by using the public API that will create a new ``FlatBufferBuilder``
     54   static func pack(_ builder: inout FlatBufferBuilder, obj: inout T?) -> Offset
     55 
     56   /// ``pack(_:obj:)-20ipk`` packs the variables of a native Object into the `ByteBuffer` by using
     57   /// the FlatBufferBuilder
     58   /// - Parameters:
     59   ///   - builder: FlatBufferBuilder that will host incoming data
     60   ///   - obj: Object of associatedtype to the current implementer
     61   ///
     62   /// ``pack(_:obj:)-20ipk`` can be called by passing through an already initialized ``FlatBufferBuilder``
     63   /// or it can be called by using the public API that will create a new ``FlatBufferBuilder``
     64   static func pack(_ builder: inout FlatBufferBuilder, obj: inout T) -> Offset
     65 
     66   /// ``unpack()`` unpacks a ``FlatBuffers`` object into a Native swift object.
     67   mutating func unpack() -> T
     68 }