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 /// NativeObject is a protocol that all of the `Object-API` generated code should be 20 /// conforming to since it allows developers the ease of use to pack and unpack their 21 /// Flatbuffers objects 22 public protocol NativeObject {} 23 24 extension NativeObject { 25 26 /// Serialize is a helper function that serializes the data from the Object API to a bytebuffer directly th 27 /// - Parameter type: Type of the Flatbuffer object 28 /// - Returns: returns the encoded sized ByteBuffer serialize<T: ObjectAPIPacker>null29 public func serialize<T: ObjectAPIPacker>(type: T.Type) -> ByteBuffer 30 where T.T == Self 31 { 32 var builder = FlatBufferBuilder(initialSize: 1024) 33 return serialize(builder: &builder, type: type.self) 34 } 35 36 /// Serialize is a helper function that serializes the data from the Object API to a bytebuffer directly. 37 /// 38 /// - Parameters: 39 /// - builder: A FlatBufferBuilder 40 /// - type: Type of the Flatbuffer object 41 /// - Returns: returns the encoded sized ByteBuffer 42 /// - Note: The `serialize(builder:type)` can be considered as a function that allows you to create smaller builder instead of the default `1024`. 43 /// It can be considered less expensive in terms of memory allocation 44 public func serialize<T: ObjectAPIPacker>( 45 builder: inout FlatBufferBuilder, 46 type: T.Type) -> ByteBuffer where T.T == Self 47 { 48 var s = self 49 let root = type.pack(&builder, obj: &s) 50 builder.finish(offset: root) 51 return builder.sizedBuffer 52 } 53 } 54