Azure / Azure/azure-sdk

Rust Guidelines: Paging page types should reference the current model/iterator guidance

Open
#9,951 1 comment 0 reactions 0 assignees View on GitHub
customer-reported needs-triage question
Dominant language
PowerShell
Stars
597
Forks
374
Avg merge
5d 21h
Merged PRs (30d)
42

Description

Bad code snippet:
```rust
pub struct FeedPage {}
```

What it should do:
The current Rust guidance is out of date. The feedback in APIView correctly points to the cited paging/model guidelines, but those guidelines no longer reflect the intended shape for Rust paging types in `azure_data_cosmos`. Please update the official Rust guideline so it clearly describes the current requirements for page types (including `azure_core::Model` and `IntoIterator` behavior, if still applicable).

Good code snippet:
```rust
pub struct FeedPage {
// page fields
}

impl azure_core::Model for FeedPage {
// current expected implementation
}

impl IntoIterator for FeedPage {
type Item = T;
type IntoIter = std::vec::IntoIter;

fn into_iter(self) -> Self::IntoIter {
// iterate over page items
}
}
```

Contributor guide

Open the contributing guide

Research direction

Locate the cited Rust paging and model guidelines, then compare them with the current azure_data_cosmos page types. Confirm whether azure_core::Model and IntoIterator remain required, and update the official guidance so its requirements and examples match the current intended shape.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.