Skip to main content
←API Reference ←NSDK

Nsdk_Vps_FloatArray


Declaration​

nonisolated struct Nsdk_Vps_FloatArray

Constructors​

Constructor​

init()

Summary​

Creates a new message with all of its fields initialized to their default
values.


Overload 1​

init(jsonString: String, options: JSONDecodingOptions = JSONDecodingOptions()) throws

Summary​

Creates a new message by decoding the given string containing a
serialized message in JSON format.

Throws​

  • SwiftProtobufError or JSONDecodingError if decoding fails.

Parameters​

NameTypeSummary
jsonStringString
The JSON-formatted string to decode.
optionsJSONDecodingOptions
The JSONDecodingOptions to use.

Overload 2​

init<Bytes>(jsonUTF8Bytes: Bytes, options: JSONDecodingOptions = JSONDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes

Summary​

Creates a new message by decoding the given SwiftProtobufContiguousBytes
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded
text.

Throws​

  • SwiftProtobufError or JSONDecodingError if decoding fails.

Parameters​

NameTypeSummary
jsonUTF8BytesBytes
The JSON-formatted data to decode, represented
as UTF-8 encoded text.
optionsJSONDecodingOptions
The JSONDecodingOptions to use.

Overload 3​

init(jsonUTF8Data: Data, options: JSONDecodingOptions = JSONDecodingOptions()) throws

Summary​

Creates a new message by decoding the given Data containing a serialized message
in JSON format, interpreting the data as UTF-8 encoded text.

Throws​

  • SwiftProtobufError or JSONDecodingError if decoding fails.

Parameters​

NameTypeSummary
jsonUTF8DataData
The JSON-formatted data to decode, represented
as UTF-8 encoded text.
optionsJSONDecodingOptions
The JSONDecodingOptions to use.

Overload 4​

init(textFormatString: String, extensions: (any ExtensionMap)? = nil) throws

Summary​

Creates a new message by decoding the given string containing a
serialized message in Protocol Buffer text format.

Throws​

  • SwiftProtobufError on failure.

Parameters​

NameTypeSummary
textFormatStringString
The text format string to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.

Overload 5​

init(jsonString: String, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws

Summary​

Creates a new message by decoding the given string containing a
serialized message in JSON format.

Throws​

  • SwiftProtobufError or JSONDecodingError if decoding fails.

Parameters​

NameTypeSummary
jsonStringString
The JSON-formatted string to decode.
extensions (any ExtensionMap)?
An ExtensionMap for looking up extensions by name
optionsJSONDecodingOptions
The JSONDecodingOptions to use.

Overload 6​

init<Bytes>(jsonUTF8Bytes: Bytes, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes

Summary​

Creates a new message by decoding the given SwiftProtobufContiguousBytes
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded
text.

Throws​

  • SwiftProtobufError or JSONDecodingError if decoding fails.

Parameters​

NameTypeSummary
jsonUTF8BytesBytes
The JSON-formatted data to decode, represented
as UTF-8 encoded text.
extensions (any ExtensionMap)?
The extension map to use with this decode
optionsJSONDecodingOptions
The JSONDecodingOptions to use.

Overload 7​

init(jsonUTF8Data: Data, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws

Summary​

Creates a new message by decoding the given Data containing a serialized message
in JSON format, interpreting the data as UTF-8 encoded text.

Throws​

  • SwiftProtobufError or JSONDecodingError if decoding fails.

Parameters​

NameTypeSummary
jsonUTF8DataData
The JSON-formatted data to decode, represented
as UTF-8 encoded text.
extensions (any ExtensionMap)?
The extension map to use with this decode
optionsJSONDecodingOptions
The JSONDecodingOptions to use.

Overload 8​

init(textFormatString: String, options: TextFormatDecodingOptions = TextFormatDecodingOptions(), extensions: (any ExtensionMap)? = nil) throws

Summary​

Creates a new message by decoding the given string containing a
serialized message in Protocol Buffer text format.

Throws​

  • TextFormatDecodingError on failure.

Parameters​

NameTypeSummary
textFormatStringString
The text format string to decode.
optionsTextFormatDecodingOptions
The TextFormatDecodingOptions to use.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.

Overload 9​

init(unpackingAny: Google_Protobuf_Any, extensions: (any ExtensionMap)? = nil, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws

Summary​

Initialize this message from the provided google.protobuf.Any
well-known type.
This corresponds to the unpack method in the Google C++ API.
If the Any object was decoded from Protobuf Binary or JSON
format, then the enclosed field data was stored and is not
fully decoded until you unpack the Any object into a message.
As such, this method will typically need to perform a full
deserialization of the enclosed data and can fail for any
reason that deserialization can fail.
See Google_Protobuf_Any.unpackTo() for more discussion.

Throws​

  • an instance of AnyUnpackError, JSONDecodingError, or BinaryDecodingError on failure.

Parameters​

NameTypeSummary
unpackingAnyGoogle_Protobuf_Any
the message to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.
optionsBinaryDecodingOptions
The BinaryDecodingOptions to use.

Overload 10​

init<Bytes>(contiguousBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes

Summary​

Creates a new message by decoding the given Foundation/ContiguousBytes value
containing a serialized message in Protocol Buffer binary format.

Throws​

  • SwiftProtobufError if decoding fails.

Parameters​

NameTypeSummary
bytesBytes
The binary-encoded message data to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.
partialBool
If false (the default), this method will check
Message/isInitialized-6abgi after decoding to verify that all required
fields are present. If any are missing, this method throws
BinaryDecodingError/missingRequiredFields.
optionsBinaryDecodingOptions
The BinaryDecodingOptions to use.

Overload 11​

init<Bytes>(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes

Summary​

Creates a new message by decoding the given SwiftProtobufContiguousBytes value
containing a serialized message in Protocol Buffer binary format.

Throws​

  • BinaryDecodingError if decoding fails.

Parameters​

NameTypeSummary
bytesBytes
The binary-encoded message data to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.
partialBool
If false (the default), this method will check
Message/isInitialized-6abgi after decoding to verify that all required
fields are present. If any are missing, this method throws
BinaryDecodingError/missingRequiredFields.
optionsBinaryDecodingOptions
The BinaryDecodingOptions to use.

Overload 12​

init(serializedBytes bytes: RawSpan, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws

Summary​

Creates a new message by decoding the bytes provided by a RawSpan
containing a serialized message in Protocol Buffer binary format.

Throws​

  • BinaryDecodingError if decoding fails.

Parameters​

NameTypeSummary
bytesRawSpan
The RawSpan of binary-encoded message data to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.
partialBool
If false (the default), this method will check
Message/isInitialized-6abgi after decoding to verify that all required
fields are present. If any are missing, this method throws
BinaryDecodingError/missingRequiredFields.
optionsBinaryDecodingOptions
The BinaryDecodingOptions to use.

Overload 13​

init<Bytes>(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes

Summary​

Creates a new message by decoding the given Foundation/ContiguousBytes value
containing a serialized message in Protocol Buffer binary format.

Throws​

  • SwiftProtobufError if decoding fails.

Parameters​

NameTypeSummary
bytesBytes
The binary-encoded message data to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.
partialBool
If false (the default), this method will check
Message/isInitialized-6abgi after decoding to verify that all required
fields are present. If any are missing, this method throws
BinaryDecodingError/missingRequiredFields.
optionsBinaryDecodingOptions
The BinaryDecodingOptions to use.

Overload 14​

init(serializedData data: Data, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws

Summary​

Creates a new message by decoding the given Data value
containing a serialized message in Protocol Buffer binary format.

Throws​

  • BinaryDecodingError if decoding fails.

Parameters​

NameTypeSummary
dataData
The binary-encoded message Data to decode.
extensions (any ExtensionMap)?
An ExtensionMap used to look up and decode any
extensions in this message or messages nested within this message's
fields.
partialBool
If false (the default), this method will check
Message/isInitialized-6abgi after decoding to verify that all required
fields are present. If any are missing, this method throws
BinaryDecodingError/missingRequiredFields.
optionsBinaryDecodingOptions
The BinaryDecodingOptions to use.

Properties​

NameTypeSummary
var debugDescriptionString
A description generated by recursively visiting all fields in the message,
including messages.
var isInitializedBool
Generated proto2 messages that contain required fields, nested messages
that contain required fields, and/or extensions will provide their own
implementation of this property that tests that all required fields are
set. Users of the generated code SHOULD NOT override this property.
static let protoMessageNameString
The fully-scoped name of the message from the original .proto file,
including any relevant package name.
var unknownFieldsUnknownStorage
Some formats include enough information to transport fields that were
not known at generation time. When encountered, they are stored here.
var value [Float]
-

Methods​

NameTypeSummary
static array[Self]
Creates a new array of messages by decoding the given string containing a
serialized array of messages in JSON format.
mutating decodeMessage<D>(decodervoid
Decode all of the fields from the given decoder.
This is a simple loop that repeatedly gets the next field number
from decoder.nextFieldNumber() and then uses the number returned
and the type information from the original .proto file to decide
what type of data should be decoded for that field. The corresponding
method on the decoder is then called to get the field value.
This is the core method used by the deserialization machinery. It is
public to enable users to implement their own encoding formats by
conforming to Decoder; it should not be called otherwise.
Note that this is not specific to binary encodng; formats that use
textual identifiers translate those to field numbers and also go
through this to decode messages.
hashvoid
A hash based on the message's full contents.
isEqualToBool
Helper to compare Messages when not having a specific type to use
normal Equatable. Equatable is provided with specific generated
types.
static isPathValidBool
Checks whether the given path is valid for Message type.
jsonStringString
Returns a string containing the JSON serialization of the message.
Unlike binary encoding, presence of required fields is not enforced when
serializing to JSON.
jsonUTF8Bytes<Bytes>(optionsBytes
Returns a SwiftProtobufContiguousBytes containing the UTF-8 JSON serialization of the message.
Unlike binary encoding, presence of required fields is not enforced when
serializing to JSON.
jsonUTF8DataData
Returns a Data containing the UTF-8 JSON serialization of the message.
Unlike binary encoding, presence of required fields is not enforced when
serializing to JSON.
mutating merge<Bytes>(serializedBytes bytesvoid
Updates the message by decoding the given SwiftProtobufContiguousBytes value
containing a serialized message in Protocol Buffer binary format into the
receiver.
serializedBytes<Bytes>(partialBytes
Returns a SwiftProtobufContiguousBytes instance containing the Protocol Buffer binary
format serialization of the message.
serializedDataData
Returns a Data instance containing the Protocol Buffer binary
format serialization of the message.
textFormatStringString
Returns a string containing the Protocol Buffer text format serialization
of the message.
Unlike binary encoding, presence of required fields is not enforced when
serializing to text format.
traverse<V>(visitorvoid
Traverses the fields of the message, calling the appropriate methods
of the passed Visitor object.
This is used internally by:
* Protobuf binary serialization
* JSON serialization (with some twists to account for specialty JSON)
* Protobuf Text serialization
* Hashable computation
Conceptually, serializers create visitor objects that are
then passed recursively to every message and field via generated
traverse methods. The details get a little involved due to
the need to allow particular messages to override particular
behaviors for specific encodings, but the general idea is quite simple.
@discardableResult mutating trimBool
Removes from 'message' any field that is not represented in the given
FieldMask. If the FieldMask is empty, does nothing.
static withSelf
Creates an instance of the message type on which this method is called,
executes the given block passing the message in as its sole inout
argument, and then returns the message.
This method acts essentially as a "builder" in that the initialization of
the message is captured within the block, allowing the returned value to
be set in an immutable variable. For example,
let msg = MyMessage.with { $0.myField = "foo" }
msg.myOtherField = 5 // error: msg is immutable

Operators​

NameTypeSummary
static func != Bool
Returns a Boolean value indicating whether two values are not equal.
Inequality is the inverse of equality. For any values a and b, a != b
implies that a == b is false.
This is the default implementation of the not-equal-to operator (!=)
for any type that conforms to Equatable.
static func == Bool
Returns a Boolean value indicating whether two values are equal.
Equality is the inverse of inequality. For any values a and b,
a == b implies that a != b is false.
static func == Bool
Returns a Boolean value indicating whether two values are equal.
Equality is the inverse of inequality. For any values a and b,
a == b implies that a != b is false.

Relationships​

conforms to: Swift.Sendable
conforms to: Swift.SendableMetatype

conforms to: SwiftProtobuf.Message

conforms to: Swift.CustomDebugStringConvertible
conforms to: Swift.Hashable
conforms to: Swift.Equatable
conforms to: Swift.Copyable