Add partial support to the binary decoding initializer. #290
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Added second commit with docs. |
thomasvl
force-pushed
the
partial_decode
branch
2 times, most recently
from
4939b2d to
af68441
Compare
allevato
reviewed
Feb 21, 2017
| @@ -268,7 +268,20 @@ public extension Message { | |||
| return visitor.serializedSize | |||
| } | |||
|
|
|||
| init(serializedData data: Data, extensions: ExtensionSet? = nil) throws { | |||
| /// Initializes the message by decoding the Protocol Buffer binary serialization | |||
| /// format into for this message. | |||
| /// format into for this message. | ||
| /// | ||
| /// - Parameters: | ||
| /// - serializedData: The binary serialation data to decode. |
There was a problem hiding this comment.
s/serialation/serialization/
| /// | ||
| /// - Parameters: | ||
| /// - serializedData: The binary serialation data to decode. | ||
| /// - extensions: An `ExtensionSet` to log up and decode any extensions in this |
| /// - Parameters: | ||
| /// - serializedData: The binary serialation data to decode. | ||
| /// - extensions: An `ExtensionSet` to log up and decode any extensions in this | ||
| /// message or message nested within this message's fields. |
There was a problem hiding this comment.
"message or messages nested" (add "s")
| /// - serializedData: The binary serialation data to decode. | ||
| /// - extensions: An `ExtensionSet` to log up and decode any extensions in this | ||
| /// message or message nested within this message's fields. | ||
| /// - partial: The binary serialization format requires all `required` fields |
There was a problem hiding this comment.
"By default, the binary serialization format..."
| /// message or message nested within this message's fields. | ||
| /// - partial: The binary serialization format requires all `required` fields | ||
| /// be present; when `partial` is `false`, | ||
| /// `BinaryDecodingError.missingRequiredFields` is throw if any were missing. |
| /// be present; when `partial` is `false`, | ||
| /// `BinaryDecodingError.missingRequiredFields` is throw if any were missing. | ||
| /// When `partial` is `true`, then partial messages are allowed, and | ||
| /// `Message.isRequired` is not checked. |
There was a problem hiding this comment.
s/isRequired/isInitialized/
| /// `BinaryDecodingError.missingRequiredFields` is throw if any were missing. | ||
| /// When `partial` is `true`, then partial messages are allowed, and | ||
| /// `Message.isRequired` is not checked. | ||
| /// - Throws: An instance of `BinaryDecodingError` on failure . |
There was a problem hiding this comment.
remove space before period
| @@ -23,4 +23,8 @@ public enum BinaryDecodingError: Error { | |||
| case malformedProtobuf | |||
| /// The data being parsed does not match the type specified in the proto file | |||
| case schemaMismatch | |||
| /// The message or sub messages definitions have required fields, and the | |||
Also add tests to confirm partial and full decoding work as expected.
thomasvl
force-pushed
the
partial_decode
branch
from
af68441 to
5571ce8
Compare
allevato
approved these changes
Feb 21, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also add tests to confirm partial and full decoding work as
expected.