Renamed several types in System.Buffers.Primitives #1343

KrzysztofCwalina · 2017-03-20T16:45:00Z

Renamed:

Memory<T> to Buffer<T>
ReadOnlyMemory<T> to ReadOnlyBuffer<T>
MemoryHandle to BufferHandle
OwnedMemory<T> to Memory<T>

Moved all the types to System.Buffers namespace
Move BufferPool to System.Buffers

Made the following types internal:

OwnedArray<T>: use OwnedBuffer<T> cast and Create method to create buffers over T[] and ArraySegment<T>
ManagedBufferPool: use BufferPool.Default

The names might not be final, but I think they move us closer to where we want to be

KrzysztofCwalina · 2017-03-20T16:45:42Z

cc: @ahsonkhan, @davidfowl, @pakrym

shiftylogic · 2017-03-20T16:49:32Z

src/System.Buffers.Primitives/System/Buffers/Memory.cs

        }

-        public void CopyTo(Memory<T> memory)
+        public void CopyTo(Buffer<T> memory)


Do we care about the name of the arguments, especially for public surface?

Yeah, I will change them

ahsonkhan · 2017-03-20T17:52:47Z

samples/LowAllocationWebServer/LowAllocationWebServerLibrary/OwnedBuffer.cs


        IReadOnlyMemoryList<byte> IReadOnlyMemoryList<byte>.Rest => _next;

        // TODO: maybe these should be renamed to no conflict with OwnedMemory<T>.Length?


Does this comment still apply?

I think so, it's conflicting with Length. But I renamed the name of the class to OwnedBuffer

ahsonkhan · 2017-03-20T17:54:09Z

src/System.Buffers.Experimental/System/Buffers/IReadOnlyMemoryList.cs


 namespace System.Buffers {
-    public interface IReadOnlyMemoryList<T> : ISequence<ReadOnlyMemory<T>>
+    public interface IReadOnlyMemoryList<T> : ISequence<ReadOnlyBuffer<T>>


Do we want to rename the interface as well?

Yup. Thanks.

ahsonkhan · 2017-03-20T17:55:17Z

src/System.Buffers.Experimental/System/Buffers/OwnedNativeMemory.cs

 namespace System.Buffers
 {
-    public class OwnedNativeMemory : OwnedMemory<byte>
+    public class OwnedNativeMemory : OwnedBuffer<byte>


Change OwnedNativeMemory?

Will do. thanks.

davidfowl · 2017-03-20T19:07:23Z

src/System.Buffers.Primitives/System/Buffers/OwnedArray.cs

 namespace System.Buffers
 {
-    public sealed class OwnedArray<T> : OwnedMemory<T>
+    internal sealed class OwnedArray<T> : OwnedBuffer<T>


Why is this internal?

There are no new APIs added to OwnedArray and so no need for the type to be public.

davidfowl · 2017-03-20T19:07:35Z

src/System.Buffers.Primitives/System/Buffers/OwnedMemory.cs

        }
        #endregion
+
+        public static OwnedBuffer<T> Create(ArraySegment<T> segment)


davidfowl · 2017-03-20T19:08:06Z

src/System.Buffers.Primitives/System/Runtime/DebuggerViews.cs


 namespace System.Runtime
 {
    internal class MemoryDebuggerView<T>


BufferDebuggerView

fixed. Thanks

davidfowl · 2017-03-20T19:25:40Z

src/System.IO.Pipelines/ReadableBuffer.cs

            }

-            var buffer = new OwnedArray<byte>(data);
+            OwnedBuffer<byte> buffer = data;


Shouldn't the type be stated explicitly in this case?

This is not about guidelines/conventions. var buffer = data would declare and assign T[] buffer local. We need buffer to be OwnedBuffer<byte> not byte[]

Implicit ctor via cast via declaration?

Wouldn't var buffer = (OwnedBuffer<byte>)data; be better or expose a Create(T[] array) function or people might either get confused how to create or start using (due to not working out how to create the buffer)

var buffer = Create(new ArraySegment<T>(array, 0, array.Length);

Which would be inefficent

Drawaes · 2017-03-20T20:12:17Z

You are walking into a mine field... asp.net and .net team have different guidelines.

🍿

omariom · 2017-03-20T21:23:45Z

I like the new names.

dnfclas added the cla-already-signed label Mar 20, 2017

KrzysztofCwalina requested a review from shiftylogic March 20, 2017 16:45

KrzysztofCwalina changed the title ~~Renamed buffer related types~~ Renamed several types in System.Buffers.Primitives Mar 20, 2017

shiftylogic reviewed Mar 20, 2017

View reviewed changes

ahsonkhan reviewed Mar 20, 2017

View reviewed changes

KrzysztofCwalina force-pushed the apicleanup branch from 536c65f to fea1778 Compare March 20, 2017 18:19

davidfowl reviewed Mar 20, 2017

View reviewed changes

renamed buffer related types

6152c23

KrzysztofCwalina force-pushed the apicleanup branch from fea1778 to 6152c23 Compare March 20, 2017 20:28

KrzysztofCwalina merged commit 3bd0ffd into dotnet:master Mar 20, 2017

benaadams mentioned this pull request Mar 21, 2017

Respond to corefxlab rename (build break) aspnet/KestrelHttpServer#1529

Merged

KrzysztofCwalina deleted the apicleanup branch March 23, 2017 15:30

benaadams mentioned this pull request Apr 2, 2017

Need to simplify getting Buffer from Array and ArraySegment #1417

Closed

ahsonkhan mentioned this pull request Apr 6, 2017

Update the use of Memory<T> in documents within the repo to Buffer<T> #1439

Closed


		IReadOnlyMemoryList<byte> IReadOnlyMemoryList<byte>.Rest => _next;

		// TODO: maybe these should be renamed to no conflict with OwnedMemory<T>.Length?

Renamed several types in System.Buffers.Primitives #1343

Renamed several types in System.Buffers.Primitives #1343

Uh oh!

Conversation

KrzysztofCwalina commented Mar 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KrzysztofCwalina commented Mar 20, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KrzysztofCwalina Mar 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Drawaes commented Mar 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

omariom commented Mar 20, 2017

Uh oh!

Uh oh!

KrzysztofCwalina commented Mar 20, 2017 •

edited

Loading

KrzysztofCwalina Mar 20, 2017 •

edited

Loading

Drawaes commented Mar 20, 2017 •

edited

Loading