Fixes spelling mistake in the word position (#8330)

This commit is contained in:
mustiikhalil
2024-10-05 00:16:28 +02:00
committed by GitHub
parent 2436bd8175
commit b127c57ff0
12 changed files with 57 additions and 59 deletions

View File

@@ -811,7 +811,7 @@ public struct FlatBufferBuilder {
/// *NOTE: Never call this manually*
///
/// - Parameter element: Element to insert
/// - returns: Postion of the Element
/// - returns: position of the Element
@inline(__always)
@discardableResult
mutating public func push<T: Scalar>(element: T) -> UOffset {

View File

@@ -21,7 +21,7 @@ public protocol Mutable {
/// makes Flatbuffer accessed within the Protocol
var bb: ByteBuffer { get }
/// makes position of the ``Table``/``Struct`` accessed within the Protocol
var postion: Int32 { get }
var position: Int32 { get }
}
extension Mutable {
@@ -45,7 +45,7 @@ extension Mutable where Self == Table {
/// - index: index of the Element
public func mutate<T: Scalar>(_ value: T, index: Int32) -> Bool {
guard index != 0 else { return false }
return mutate(value: value, o: index + postion)
return mutate(value: value, o: index + position)
}
/// Directly mutates the element by calling mutate
@@ -66,7 +66,7 @@ extension Mutable where Self == Struct {
/// - value: New value to be inserted to the buffer
/// - index: index of the Element
public func mutate<T: Scalar>(_ value: T, index: Int32) -> Bool {
mutate(value: value, o: index + postion)
mutate(value: value, o: index + position)
}
/// Directly mutates the element by calling mutate

View File

@@ -24,7 +24,7 @@ public struct Struct {
/// Hosting Bytebuffer
public private(set) var bb: ByteBuffer
/// Current position of the struct
public private(set) var postion: Int32
public private(set) var position: Int32
/// Initializer for a mutable flatbuffers struct
/// - Parameters:
@@ -32,7 +32,7 @@ public struct Struct {
/// - position: Current position for the struct in the ByteBuffer
public init(bb: ByteBuffer, position: Int32 = 0) {
self.bb = bb
postion = position
self.position = position
}
/// Reads data from the buffer directly at offset O
@@ -41,7 +41,7 @@ public struct Struct {
/// - o: Current offset of the data
/// - Returns: Data of Type T that conforms to type Scalar
public func readBuffer<T: Scalar>(of type: T.Type, at o: Int32) -> T {
let r = bb.read(def: T.self, position: Int(o + postion))
let r = bb.read(def: T.self, position: Int(o + position))
return r
}
}

View File

@@ -24,7 +24,7 @@ public struct Table {
/// Hosting Bytebuffer
public private(set) var bb: ByteBuffer
/// Current position of the table within the buffer
public private(set) var postion: Int32
public private(set) var position: Int32
/// Initializer for the table interface to allow generated code to read
/// data from memory
@@ -38,7 +38,7 @@ public struct Table {
"Reading/Writing a buffer in big endian machine is not supported on swift")
}
self.bb = bb
postion = position
self.position = position
}
/// Gets the offset of the current field within the buffer by reading
@@ -46,7 +46,7 @@ public struct Table {
/// - Parameter o: current offset
/// - Returns: offset of field within buffer
public func offset(_ o: Int32) -> Int32 {
let vtable = postion - bb.read(def: Int32.self, position: Int(postion))
let vtable = position - bb.read(def: Int32.self, position: Int(position))
return o < bb
.read(def: VOffset.self, position: Int(vtable)) ? Int32(bb.read(
def: Int16.self,
@@ -64,7 +64,7 @@ public struct Table {
/// String reads from the buffer with respect to position of the current table.
/// - Parameter offset: Offset of the string
public func string(at offset: Int32) -> String? {
directString(at: offset + postion)
directString(at: offset + position)
}
/// Direct string reads from the buffer disregarding the position of the table.
@@ -84,7 +84,7 @@ public struct Table {
/// - type: Type of Element that needs to be read from the buffer
/// - o: Offset of the Element
public func readBuffer<T>(of type: T.Type, at o: Int32) -> T {
directRead(of: T.self, offset: o + postion)
directRead(of: T.self, offset: o + position)
}
/// Reads from the buffer disregarding the position of the table.
@@ -110,7 +110,7 @@ public struct Table {
/// - Parameter o: offset
/// - Returns: A flatbuffers object
public func union<T: FlatbuffersInitializable>(_ o: Int32) -> T {
let o = o + postion
let o = o + position
return directUnion(o)
}
@@ -136,7 +136,7 @@ public struct Table {
/// - returns: Count of elements
public func vector(count o: Int32) -> Int32 {
var o = o
o += postion
o += position
o += bb.read(def: Int32.self, position: Int(o))
return bb.read(def: Int32.self, position: Int(o))
}
@@ -146,7 +146,7 @@ public struct Table {
/// - returns: the start index of the vector
public func vector(at o: Int32) -> Int32 {
var o = o
o += postion
o += position
return o + bb.read(def: Int32.self, position: Int(o)) + 4
}

View File

@@ -89,7 +89,7 @@ public struct Verifier {
/// Checks if the value of Size "X" is within the range of the buffer
/// - Parameters:
/// - position: Current postion to be read
/// - position: Current position to be read
/// - size: `Byte` Size of readable object within the buffer
/// - Throws: `outOfBounds` if the value is out of the bounds of the buffer
/// and `apparentSizeTooLarge` if the apparent size is bigger than the one specified