Skip to content

Revisit protocol and convenience surface separation for streaming APIs #61990

Description

@JoshLove-msft

Context

The current streaming result name and shape were designed to unify the type used across protocol and convenience surfaces.

Concern

Using one type for both surfaces may be contributing to discoverability and API-shape compromises. We should revisit whether protocol and convenience APIs need to return the same type.

Option to consider

  • Have the protocol surface return the standard ClientResult.
  • Introduce an AsyncStreamingCollection<T> convenience type.
  • Provide a static FromResult factory to create the convenience wrapper from the protocol result.

Goal

Determine whether separating protocol and convenience return types produces a clearer streaming API without making interoperation cumbersome.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Azure.CoreClientThis issue points to a problem in the data-plane of the library.design-discussionAn area of design currently under discussion and open to team and community feedback.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions