Add StyleManagerProtocol #317
Merged
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
julianrex
added
the
breaking change ⚠️
| /// - update: Closure that mutates a layer passed to it | ||
| /// - Returns: Result type with `.success` if update is successful, `LayerError` otherwise | ||
| @discardableResult | ||
| public func updateLayer<T: Layer>(id: String, type: T.Type, update: (inout T) -> Void) -> Result<Bool, LayerError> { |
There was a problem hiding this comment.
Will this be updated as part of a future PR?
Comment on lines
+39
to
+47
| case addLayerFailed(String) | ||
|
|
||
| /// Remove the style layer from the map failed | ||
| case removeStyleLayerFailed(String?) | ||
| case removeLayerFailed(String) | ||
|
|
||
| /// Setting layer property(s) failed | ||
| case setLayerPropertyFailed(String) | ||
|
|
||
| /// The layer properties for a layer are nil |
There was a problem hiding this comment.
This whole file should go away in the future right? Are we planning on wrapping the errors from core?
| func layerExists(withId id: String) -> Bool | ||
|
|
||
| /// The ordered list of the current style layers' identifiers and types | ||
| var layerIdentifiers: [LayerInfo] { get } |
There was a problem hiding this comment.
How about renaming this to allLayerIdentifiers ?
There was a problem hiding this comment.
I'd be good with that. Will tackle in next PR.
|
A few questions but no blockers.. Thanks for breaking up the work into multiple PRs! |
nishant-karajgikar
approved these changes
May 5, 2021
neelmistry94
approved these changes
May 5, 2021
This was referenced May 5, 2021
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.
PRs must be submitted under the terms of our Contributor License Agreement CLA.
Pull request checklist:
Write tests for all new functionality. If tests were not written, please explain why.Will be addressed as tail-workmapbox-maps-ioschangelog:<changelog>Refactors existing Style API functions and adds ones that were hidden.</changelog>.Summary of changes
This is part 1 of N PRs introducing a new
StyleManagerProtocoland related public API changes.This PR:
adds a public protocol
StyleManagerProtocol, which is the Swifty equivalent of Android'sStyleManagerDelegate. As part of this effort, existing APIs that were returning aResulttype, nowthrowinstead. For example,_ = style.removeStyleLayer(forLayerId: "some-id")is replaced by
try style.removeLayer(withId: "some-id")This also exposes a number of APIs that were previously access via the "internal"
__mapproperty, for exampleaddCustomLayer.Updates related tests and examples.
Updates ResourceOptions documentation
Metrics build trigger now tries a remote branch with the same name first.