mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-04 04:33:23 +00:00
* Adds new API to reduce memory copying within swift Adds new storage container _InternalByteBuffer which will be holding the data that will be created within the swift lib, however reading data will be redirected to ByteBuffer, which should be able to handle all types of data that swift provide without the need to copy the data itself. This is due to holding a reference to the data. Replaces assumingMemoryBinding with bindMemory which is safer Adds function that provides access to a UnsafeBufferPointer for scalars and NativeStructs within swift Updates docs Suppress compilation warnings by replacing var with let Using overflow operators within swift to improve performance Adds tests for GRPC message creation from a retained _InternalByteBuffer
76 lines
2.4 KiB
Swift
76 lines
2.4 KiB
Swift
/*
|
|
* Copyright 2024 Google Inc. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import Foundation
|
|
|
|
/// FlatBufferGRPCMessage protocol that should allow us to invoke
|
|
/// initializers directly from the GRPC generated code
|
|
public protocol FlatBufferGRPCMessage {
|
|
/// Size of readable bytes in the buffer
|
|
var size: Int { get }
|
|
|
|
init(byteBuffer: ByteBuffer)
|
|
|
|
@discardableResult
|
|
@inline(__always)
|
|
func withUnsafeReadableBytes<T>(
|
|
_ body: (UnsafeRawBufferPointer) throws
|
|
-> T) rethrows -> T
|
|
}
|
|
|
|
/// Message is a wrapper around Buffers to to able to send Flatbuffers `Buffers` through the
|
|
/// GRPC library
|
|
public struct Message<T: FlatBufferObject>: FlatBufferGRPCMessage {
|
|
internal var buffer: ByteBuffer
|
|
|
|
/// Returns the an object of type T that would be read from the buffer
|
|
public var object: T {
|
|
T.init(
|
|
buffer,
|
|
o: Int32(buffer.read(def: UOffset.self, position: buffer.reader)) &+
|
|
Int32(buffer.reader))
|
|
}
|
|
|
|
public var size: Int { Int(buffer.size) }
|
|
|
|
/// Initializes the message with the type Flatbuffer.Bytebuffer that is transmitted over
|
|
/// GRPC
|
|
/// - Parameter byteBuffer: Flatbuffer ByteBuffer object
|
|
public init(byteBuffer: ByteBuffer) {
|
|
buffer = byteBuffer
|
|
}
|
|
|
|
/// Initializes the message by copying the buffer to the message to be sent.
|
|
/// from the builder
|
|
/// - Parameter builder: FlatbufferBuilder that has the bytes created in
|
|
/// - Note: Use `builder.finish(offset)` before passing the builder without prefixing anything to it
|
|
public init(builder: inout FlatBufferBuilder) {
|
|
buffer = builder.sizedBuffer
|
|
builder.clear()
|
|
}
|
|
|
|
@discardableResult
|
|
@inline(__always)
|
|
public func withUnsafeReadableBytes<Data>(
|
|
_ body: (UnsafeRawBufferPointer) throws
|
|
-> Data) rethrows -> Data
|
|
{
|
|
return try buffer.readWithUnsafeRawPointer(position: buffer.reader) {
|
|
try body(UnsafeRawBufferPointer(start: $0, count: size))
|
|
}
|
|
}
|
|
}
|