Skip to content

Add more AsSpan overloads to StringSegment #50428

Closed
#53463
Closed
Add more AsSpan overloads to StringSegment#50428
#53463
Assignees
gfoidl
Labels
api-approvedAPI was approved in API review, it can be implementedarea-Extensions-Primitives
Milestone
6.0.0

Description

@BrennanConroy
BrennanConroy
opened on Mar 30, 2021

Background and Motivation

Many classes provide AsSpan methods and most provide at least the 3 basic methods, AsSpan(), AsSpan(int start), AsSpan(int start, int length).

The StringSegment class only provides AsSpan(), but it should provide the other two for consistency and ease of use.

Proposed API

namespace Microsoft.Extensions.Primitives
{
    public readonly struct StringSegment : IEquatable<StringSegment>, IEquatable<string>
    {
        public ReadOnlySpan<char> AsSpan();
+       public ReadOnlySpan<char> AsSpan(int start);
+       public ReadOnlySpan<char> AsSpan(int start, int length);
    }
}

Usage Examples

// input.AsSpan().Slice(startIndex, typeLength);
input.AsSpan(startIndex, typeLength);

Alternative Designs

No, other classes that provide AsSpan have similar overloads

Risks

None

Activity

  1. BrennanConroy
    added
    api-suggestionEarly API idea and discussion, it is NOT ready for implementation
    on Mar 30, 2021
  2. ghost added
    area-System.Memory
    on Mar 30, 2021
  3. ghost added
    untriagedNew issue has not been triaged by the area owner
    on Mar 30, 2021
  5. stephentoub
    added
    api-ready-for-reviewAPI is ready for review, it is NOT ready for implementation
    and removed
    api-suggestionEarly API idea and discussion, it is NOT ready for implementation
    untriagedNew issue has not been triaged by the area owner
    on Mar 30, 2021
  6. eerhardt
    added
    area-Extensions-Primitives
    and removed
    area-System.Memory
    on Mar 30, 2021
  8. maryamariyan
    added this to the 6.0.0 milestone on Apr 23, 2021

  9. bartonjs commented on May 27, 2021

    @bartonjs
    bartonjs
    on May 27, 2021
    Member

    Video

    Looks good as proposed.

    namespace Microsoft.Extensions.Primitives
{
    partial struct StringSegment : IEquatable<StringSegment>, IEquatable<string>
    {
       public ReadOnlySpan<char> AsSpan(int start);
       public ReadOnlySpan<char> AsSpan(int start, int length);
    }
}
  10. bartonjs
    added
    api-approvedAPI was approved in API review, it can be implemented
    and removed
    api-ready-for-reviewAPI is ready for review, it is NOT ready for implementation
    on May 27, 2021

  11. gfoidl commented on May 28, 2021

    @gfoidl
    gfoidl
    on May 28, 2021
    Member

    I'd like to add these overloads.

  12. eerhardt
    assigned
    gfoidl
    on May 28, 2021
  13. ghost added
    in-prThere is an active PR which will close this issue when it is merged
    on May 29, 2021
  14. eerhardt
    closed this as completedin #53463on Jun 3, 2021
  15. ghost removed
    in-prThere is an active PR which will close this issue when it is merged
    on Jun 3, 2021
  16. ghost locked as resolved and limited conversation to collaborators on Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

api-approvedAPI was approved in API review, it can be implementedarea-Extensions-Primitives

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions