Initializerswift-protobuf 1.28.2SwiftProtobuf
init(serializedBytes:extensions:partial:options:)
Creates a new message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format.
This declaration is deprecated: Please conform your Bytes type to `SwiftProtobufContiguousBytes` instead of `Foundation.ContiguousBytes`.
init<Bytes>(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes Parameters
- serializedBytes
The binary-encoded message data to decode.
- extensions
An
ExtensionMapused to look up and decode any extensions in this message or messages nested within this message’s fields.- partial
If
false(the default), this method will checkisInitializedafter decoding to verify that all required fields are present. If any are missing, this method throwsSwiftProtobufError/BinaryDecoding/missingRequiredFields.- options
The
BinaryDecodingOptionsto use.
Throws
SwiftProtobufError if decoding fails.
Other members in extension
Type members
init(jsonString: String, extensions: (any ExtensionMap)?, options: JSONDecodingOptions) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init(jsonString: String, options: JSONDecodingOptions) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init<Bytes>(jsonUTF8Bytes: Bytes, extensions: (any ExtensionMap)?, options: JSONDecodingOptions) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytescontaining a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init<Bytes>(jsonUTF8Bytes: Bytes, options: JSONDecodingOptions) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytescontaining a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init(jsonUTF8Data: Data, extensions: (any ExtensionMap)?, options: JSONDecodingOptions) throws Creates a new message by decoding the given
Datacontaining a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init(jsonUTF8Data: Data, options: JSONDecodingOptions) throws Creates a new message by decoding the given
Datacontaining a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytesvalue containing a serialized message in Protocol Buffer binary format.init(textFormatString: String, extensions: (any ExtensionMap)?) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(textFormatString: String, options: TextFormatDecodingOptions, extensions: (any ExtensionMap)?) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(unpackingAny: Google_Protobuf_Any, extensions: (any ExtensionMap)?, options: BinaryDecodingOptions) throws Initialize this message from the provided
google.protobuf.Anywell-known type.static func array(fromJSONString: String, extensions: any ExtensionMap, options: JSONDecodingOptions) throws -> [Self] Creates a new array of messages by decoding the given string containing a serialized array of messages in JSON format.
static func array(fromJSONString: String, options: JSONDecodingOptions) throws -> [Self] Creates a new array of messages by decoding the given string containing a serialized array of messages in JSON format.
static func array<Bytes>(fromJSONUTF8Bytes: Bytes, extensions: any ExtensionMap, options: JSONDecodingOptions) throws -> [Self] Creates a new array of messages by decoding the given
SwiftProtobufContiguousBytescontaining a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array<Bytes>(fromJSONUTF8Bytes: Bytes, options: JSONDecodingOptions) throws -> [Self] Creates a new array of messages by decoding the given
SwiftProtobufContiguousBytescontaining a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array(fromJSONUTF8Data: Data, extensions: any ExtensionMap, options: JSONDecodingOptions) throws -> [Self] Creates a new array of messages by decoding the given
Datacontaining a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array(fromJSONUTF8Data: Data, options: JSONDecodingOptions) throws -> [Self] Creates a new array of messages by decoding the given
Datacontaining a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func isPathValid(String) -> Bool Checks whether the given path is valid for Message type.
static func jsonString<C>(from: C, options: JSONEncodingOptions) throws -> String Returns a string containing the JSON serialization of the messages.
static func jsonUTF8Bytes<C, Bytes>(from: C, options: JSONEncodingOptions) throws -> Bytes Returns a
SwiftProtobufContiguousBytescontaining the UTF-8 JSON serialization of the messages.static func jsonUTF8Data<C>(from: C, options: JSONEncodingOptions) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the messages.
static func with((inout Self) throws -> Void) rethrows -> Self Creates an instance of the message type on which this method is called, executes the given block passing the message in as its sole
inoutargument, and then returns the message.
Show obsolete interfaces (2)
Hide obsolete interfaces
init<Bytes>(contiguousBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Creates a new message by decoding the given
Foundation/ContiguousBytesvalue containing a serialized message in Protocol Buffer binary format.init(serializedData: Data, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Creates a new message by decoding the given
Datavalue containing a serialized message in Protocol Buffer binary format.
Instance members
var debugDescription: StringA description generated by recursively visiting all fields in the message, including messages.
var isInitialized: BoolGenerated 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.
func hash(into: inout Hasher) A hash based on the message’s full contents.
func jsonString(options: JSONEncodingOptions) throws -> String Returns a string containing the JSON serialization of the message.
func jsonUTF8Bytes<Bytes>(options: JSONEncodingOptions) throws -> Bytes Returns a
SwiftProtobufContiguousBytescontaining the UTF-8 JSON serialization of the message.func jsonUTF8Data(options: JSONEncodingOptions) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the message.
func merge(from: Self, fieldMask: Google_Protobuf_FieldMask, mergeOption: Google_Protobuf_FieldMask.MergeOptions) throws Merges fields specified in a FieldMask into another message.
func merge<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Updates the message by decoding the given
SwiftProtobufContiguousBytesvalue containing a serialized message in Protocol Buffer binary format into the receiver.func merge(serializedData: Data, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Updates the message by decoding the given
Datavalue containing a serialized message in Protocol Buffer binary format into the receiver.func serializedBytes<Bytes>(partial: Bool, options: BinaryEncodingOptions) throws -> Bytes Returns a
SwiftProtobufContiguousBytesinstance containing the Protocol Buffer binary format serialization of the message.func serializedData(partial: Bool) throws -> Data Returns a
Datainstance containing the Protocol Buffer binary format serialization of the message.func serializedData(partial: Bool, options: BinaryEncodingOptions) throws -> Data Returns a
Datainstance containing the Protocol Buffer binary format serialization of the message.func textFormatString() -> String Returns a string containing the Protocol Buffer text format serialization of the message.
func textFormatString(options: TextFormatEncodingOptions) -> String Returns a string containing the Protocol Buffer text format serialization of the message.
Show obsolete interfaces (2)
Hide obsolete interfaces
func merge<Bytes>(contiguousBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Updates the message by decoding the given
Foundation/ContiguousBytesvalue containing a serialized message in Protocol Buffer binary format into the receiver.func merge<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions) throws Updates the message by decoding the given
Foundation/ContiguousBytesvalue containing a serialized message in Protocol Buffer binary format into the receiver.