[WIP] Add an associated AttachmentMetadata type to Attachable.
#824
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
grynspan
added
enhancement
|
@swift-ci test |
This PR adds a new associated type to `Attachable` that can be used to supply additional metadata to an attachment that is specific to that type. Metadata is always optional and the default type is `Never` (i.e. by default there is no metadata.) The `Encodable` and `NSSecureCoding` conformances in the Foundation cross-import overlay have been updated such that this type equals a new structure that describes the format to use as well as options to pass to the JSON encoder (if one is used) and user info to pass to the plist or JSON encoders (if used.) We must use this type even for types that conform only to `NSSecureCoding`, otherwise we get compile-time errors about the type being ambiguous if a type conforms to both protocols and to `Attachable`.
grynspan
force-pushed
the
jgrynspan/attachments-metadata
branch
from
04fc8c7 to
4a39dfa
Compare
plemarquand
reviewed
Dec 11, 2024
| /// The value of this property is `nil` if you passed `nil` when initializing | ||
| /// this instance, or if you set it to `nil` at a later time. | ||
| public var metadata: AttachableValue.AttachmentMetadata? | ||
|
|
||
| /// The path to which the this attachment was written, if any. |
There was a problem hiding this comment.
Suggested change
| /// The path to which the this attachment was written, if any. | |
| /// The path to which this attachment was written, if any. |
| let attachment = Attachment( | ||
| attachableValue, | ||
| metadata: .init( | ||
| format: .propertyListFormat(.xml) |
There was a problem hiding this comment.
Could you add a similar test that checks the happy path of .json metadata serialization
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.
This PR adds a new associated type to
Attachablethat can be used to supply additional metadata to an attachment that is specific to that type. Metadata is always optional and the default type isNever(i.e. by default there is no metadata.)The
EncodableandNSSecureCodingconformances in the Foundation cross-import overlay have been updated such that this type equals a new structure that describes the format to use as well as options to pass to the JSON encoder (if one is used) and user info to pass to the plist or JSON encoders (if used.) We must use this type even for types that conform only toNSSecureCoding, otherwise we get compile-time errors about the type being ambiguous if a type conforms to both protocols and toAttachable.Checklist: