Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix iterator lifetimes #201

Merged
merged 2 commits into from
Mar 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions src/layers/group.rs
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,34 @@ map_wrapper!(

impl<'map> GroupLayer<'map> {
/// Returns an iterator over the layers present in this group in display order.
pub fn layers(&self) -> impl ExactSizeIterator<Item = Layer> {
self.layers
/// ## Example
/// ```
/// use tiled::Layer;
/// # use tiled::Loader;
///
/// # fn main() {
/// # let map = Loader::new()
/// # .load_tmx_map("assets/tiled_group_layers.tmx")
/// # .unwrap();
/// #
/// let nested_layers: Vec<Layer> = map
/// .layers()
/// .filter_map(|layer| match layer.layer_type() {
/// tiled::LayerType::GroupLayer(layer) => Some(layer),
/// _ => None,
/// })
/// .flat_map(|layer| layer.layers())
/// .collect();
///
/// dbg!(nested_layers);
/// # }
/// ```
pub fn layers(&self) -> impl ExactSizeIterator<Item = Layer<'map>> + 'map {
let map: &'map crate::Map = self.map;
self.data
.layers
.iter()
.map(move |layer| Layer::new(self.map, layer))
.map(move |layer| Layer::new(map, layer))
}
/// Gets a specific layer from the group by index.
pub fn get_layer(&self, index: usize) -> Option<Layer> {
Expand Down
32 changes: 29 additions & 3 deletions src/layers/object.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,36 @@ impl<'map> ObjectLayer<'map> {

/// Returns an iterator over the objects present in this layer, in the order they were declared
/// in in the TMX file.
///
/// ## Example
/// ```
/// # use tiled::Loader;
/// use tiled::Object;
///
/// # fn main() {
/// # let map = Loader::new()
/// # .load_tmx_map("assets/tiled_group_layers.tmx")
/// # .unwrap();
/// #
/// let spawnpoints: Vec<Object> = map
/// .layers()
/// .filter_map(|layer| match layer.layer_type() {
/// tiled::LayerType::ObjectLayer(layer) => Some(layer),
/// _ => None,
/// })
/// .flat_map(|layer| layer.objects())
/// .filter(|object| object.obj_type == "spawn")
/// .collect();
///
/// dbg!(spawnpoints);
/// # }
/// ```
#[inline]
pub fn objects(&self) -> impl ExactSizeIterator<Item = Object> {
self.objects
pub fn objects(&self) -> impl ExactSizeIterator<Item = Object<'map>> + 'map {
let map: &'map crate::Map = self.map;
self.data
.objects
.iter()
.map(move |object| Object::new(self.map, object))
.map(move |object| Object::new(map, object))
}
}
25 changes: 25 additions & 0 deletions src/map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,31 @@ impl Map {
}

/// Get an iterator over all the layers in the map in ascending order of their layer index.
///
/// ## Example
/// ```
/// # use tiled::Loader;
/// #
/// # fn main() {
/// # struct Renderer;
/// # impl Renderer {
/// # fn render(&self, _: tiled::TileLayer) {}
/// # }
/// # let my_renderer = Renderer;
/// # let map = Loader::new()
/// # .load_tmx_map("assets/tiled_group_layers.tmx")
/// # .unwrap();
/// #
/// let tile_layers = map.layers().filter_map(|layer| match layer.layer_type() {
/// tiled::LayerType::TileLayer(layer) => Some(layer),
/// _ => None,
/// });
///
/// for layer in tile_layers {
/// my_renderer.render(layer);
/// }
/// # }
/// ```
#[inline]
pub fn layers(&self) -> impl ExactSizeIterator<Item = Layer> {
self.layers.iter().map(move |layer| Layer::new(self, layer))
Expand Down