Add scope decorations to std.socket (#8438)

schveiguy · web-flow · commit f712d16b0ac6 · 2022-05-07T20:28:19.000+08:00
diff --git a/changelog/scopesocket.dd b/changelog/scopesocket.dd
@@ -0,0 +1,9 @@
+`std.socket.Socket` methods now accept only `scope` arrays.
+
+To comply with dip1000, `std.socket.Socket` methods now all have `scope`
+attributes applied to any slice parameters. This includes `receive` and `send`
+flavors, and also `setOption`. While not technically a breaking change for
+users of `Socket`, if you derive from it, you must apply those attributes to your
+derivatives or it will fail to compile. However, applying the attributes is
+backwards compatible with previous versions of Phobos, so there is no need for
+a migration path.
diff --git a/std/socket.d b/std/socket.d
@@ -3000,7 +3000,7 @@ public:
      * Returns: The number of bytes actually sent, or `Socket.ERROR` on
      * failure.
      */
-    ptrdiff_t send(const(void)[] buf, SocketFlags flags) @trusted
+    ptrdiff_t send(scope const(void)[] buf, SocketFlags flags) @trusted
     {
         static if (is(typeof(MSG_NOSIGNAL)))
         {
@@ -3014,7 +3014,7 @@ public:
     }
 
     /// ditto
-    ptrdiff_t send(const(void)[] buf)
+    ptrdiff_t send(scope const(void)[] buf)
     {
         return send(buf, SocketFlags.NONE);
     }
@@ -3026,7 +3026,7 @@ public:
      * Returns: The number of bytes actually sent, or `Socket.ERROR` on
      * failure.
      */
-    ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags, Address to) @trusted
+    ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags, Address to) @trusted
     {
         static if (is(typeof(MSG_NOSIGNAL)))
         {
@@ -3042,15 +3042,15 @@ public:
     }
 
     /// ditto
-    ptrdiff_t sendTo(const(void)[] buf, Address to)
+    ptrdiff_t sendTo(scope const(void)[] buf, Address to)
     {
         return sendTo(buf, SocketFlags.NONE, to);
     }
 
 
     //assumes you connect()ed
     /// ditto
-    ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags) @trusted
+    ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags) @trusted
     {
         static if (is(typeof(MSG_NOSIGNAL)))
         {
@@ -3065,7 +3065,7 @@ public:
 
     //assumes you connect()ed
     /// ditto
-    ptrdiff_t sendTo(const(void)[] buf)
+    ptrdiff_t sendTo(scope const(void)[] buf)
     {
         return sendTo(buf, SocketFlags.NONE);
     }
@@ -3077,7 +3077,7 @@ public:
      * Returns: The number of bytes actually received, `0` if the remote side
      * has closed the connection, or `Socket.ERROR` on failure.
      */
-    ptrdiff_t receive(void[] buf, SocketFlags flags) @trusted
+    ptrdiff_t receive(scope void[] buf, SocketFlags flags) @trusted
     {
         version (Windows)         // Does not use size_t
         {
@@ -3094,7 +3094,7 @@ public:
     }
 
     /// ditto
-    ptrdiff_t receive(void[] buf)
+    ptrdiff_t receive(scope void[] buf)
     {
         return receive(buf, SocketFlags.NONE);
     }
@@ -3106,7 +3106,7 @@ public:
      * Returns: The number of bytes actually received, `0` if the remote side
      * has closed the connection, or `Socket.ERROR` on failure.
      */
-    ptrdiff_t receiveFrom(void[] buf, SocketFlags flags, ref Address from) @trusted
+    ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags, ref Address from) @trusted
     {
         if (!buf.length)         //return 0 and don't think the connection closed
             return 0;
@@ -3129,15 +3129,15 @@ public:
 
 
     /// ditto
-    ptrdiff_t receiveFrom(void[] buf, ref Address from)
+    ptrdiff_t receiveFrom(scope void[] buf, ref Address from)
     {
         return receiveFrom(buf, SocketFlags.NONE, from);
     }
 
 
     //assumes you connect()ed
     /// ditto
-    ptrdiff_t receiveFrom(void[] buf, SocketFlags flags) @trusted
+    ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags) @trusted
     {
         if (!buf.length)         //return 0 and don't think the connection closed
             return 0;
@@ -3158,7 +3158,7 @@ public:
 
     //assumes you connect()ed
     /// ditto
-    ptrdiff_t receiveFrom(void[] buf)
+    ptrdiff_t receiveFrom(scope void[] buf)
     {
         return receiveFrom(buf, SocketFlags.NONE);
     }
@@ -3169,7 +3169,7 @@ public:
      * Returns: The number of bytes written to `result`.
      * The length, in bytes, of the actual result - very different from getsockopt()
      */
-    int getOption(SocketOptionLevel level, SocketOption option, void[] result) @trusted
+    int getOption(SocketOptionLevel level, SocketOption option, scope void[] result) @trusted
     {
         socklen_t len = cast(socklen_t) result.length;
         if (_SOCKET_ERROR == .getsockopt(sock, cast(int) level, cast(int) option, result.ptr, &len))
@@ -3217,7 +3217,7 @@ public:
     }
 
     /// Set a socket option.
-    void setOption(SocketOptionLevel level, SocketOption option, void[] value) @trusted
+    void setOption(SocketOptionLevel level, SocketOption option, scope void[] value) @trusted
     {
         if (_SOCKET_ERROR == .setsockopt(sock, cast(int) level,
                                         cast(int) option, value.ptr, cast(uint) value.length))
@@ -3647,55 +3647,55 @@ class UdpSocket: Socket
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @trusted ptrdiff_t send(const(void)[] buf, SocketFlags flags)
+            @trusted ptrdiff_t send(scope const(void)[] buf, SocketFlags flags)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @safe ptrdiff_t send(const(void)[] buf)
+            @safe ptrdiff_t send(scope const(void)[] buf)
             {
                 checkAttributes!q{@safe}; assert(0);
             }
-            @trusted ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags, Address to)
+            @trusted ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags, Address to)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @safe ptrdiff_t sendTo(const(void)[] buf, Address to)
+            @safe ptrdiff_t sendTo(scope const(void)[] buf, Address to)
             {
                 checkAttributes!q{@safe}; assert(0);
             }
-            @trusted ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags)
+            @trusted ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @safe ptrdiff_t sendTo(const(void)[] buf)
+            @safe ptrdiff_t sendTo(scope const(void)[] buf)
             {
                 checkAttributes!q{@safe}; assert(0);
             }
-            @trusted ptrdiff_t receive(void[] buf, SocketFlags flags)
+            @trusted ptrdiff_t receive(scope void[] buf, SocketFlags flags)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @safe ptrdiff_t receive(void[] buf)
+            @safe ptrdiff_t receive(scope void[] buf)
             {
                 checkAttributes!q{@safe}; assert(0);
             }
-            @trusted ptrdiff_t receiveFrom(void[] buf, SocketFlags flags, ref Address from)
+            @trusted ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags, ref Address from)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @safe ptrdiff_t receiveFrom(void[] buf, ref Address from)
+            @safe ptrdiff_t receiveFrom(scope void[] buf, ref Address from)
             {
                 checkAttributes!q{@safe}; assert(0);
             }
-            @trusted ptrdiff_t receiveFrom(void[] buf, SocketFlags flags)
+            @trusted ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
-            @safe ptrdiff_t receiveFrom(void[] buf)
+            @safe ptrdiff_t receiveFrom(scope void[] buf)
             {
                 checkAttributes!q{@safe}; assert(0);
             }
-            @trusted int getOption(SocketOptionLevel level, SocketOption option, void[] result)
+            @trusted int getOption(SocketOptionLevel level, SocketOption option, scope void[] result)
             {
                 checkAttributes!q{@trusted}; assert(0);
             }
@@ -3711,7 +3711,7 @@ class UdpSocket: Socket
             {
                 checkAttributes!q{@trusted};
             }
-            @trusted void setOption(SocketOptionLevel level, SocketOption option, void[] value)
+            @trusted void setOption(SocketOptionLevel level, SocketOption option, scope void[] value)
             {
                 checkAttributes!q{@trusted};
             }
@@ -3793,11 +3793,11 @@ Socket[2] socketPair() @trusted
 ///
 @safe unittest
 {
-    immutable ubyte[] data = [1, 2, 3, 4];
+    immutable ubyte[4] data = [1, 2, 3, 4];
     auto pair = socketPair();
     scope(exit) foreach (s; pair) s.close();
 
-    pair[0].send(data);
+    pair[0].send(data[]);
 
     auto buf = new ubyte[data.length];
     pair[1].receive(buf);

Original file line number	Diff line number	Diff line change
`@@ -3000,7 +3000,7 @@ public:`
`3000`	`3000`	* Returns: The number of bytes actually sent, or `Socket.ERROR` on
`3001`	`3001`	`* failure.`
`3002`	`3002`	`*/`
`3003`		`- ptrdiff_t send(const(void)[] buf, SocketFlags flags) @trusted`
	`3003`	`+ ptrdiff_t send(scope const(void)[] buf, SocketFlags flags) @trusted`
`3004`	`3004`	`{`
`3005`	`3005`	`static if (is(typeof(MSG_NOSIGNAL)))`
`3006`	`3006`	`{`
`@@ -3014,7 +3014,7 @@ public:`
`3014`	`3014`	`}`
`3015`	`3015`
`3016`	`3016`	`/// ditto`
`3017`		`- ptrdiff_t send(const(void)[] buf)`
	`3017`	`+ ptrdiff_t send(scope const(void)[] buf)`
`3018`	`3018`	`{`
`3019`	`3019`	`return send(buf, SocketFlags.NONE);`
`3020`	`3020`	`}`
`@@ -3026,7 +3026,7 @@ public:`
`3026`	`3026`	* Returns: The number of bytes actually sent, or `Socket.ERROR` on
`3027`	`3027`	`* failure.`
`3028`	`3028`	`*/`
`3029`		`- ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags, Address to) @trusted`
	`3029`	`+ ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags, Address to) @trusted`
`3030`	`3030`	`{`
`3031`	`3031`	`static if (is(typeof(MSG_NOSIGNAL)))`
`3032`	`3032`	`{`
`@@ -3042,15 +3042,15 @@ public:`
`3042`	`3042`	`}`
`3043`	`3043`
`3044`	`3044`	`/// ditto`
`3045`		`- ptrdiff_t sendTo(const(void)[] buf, Address to)`
	`3045`	`+ ptrdiff_t sendTo(scope const(void)[] buf, Address to)`
`3046`	`3046`	`{`
`3047`	`3047`	`return sendTo(buf, SocketFlags.NONE, to);`
`3048`	`3048`	`}`
`3049`	`3049`
`3050`	`3050`
`3051`	`3051`	`//assumes you connect()ed`
`3052`	`3052`	`/// ditto`
`3053`		`- ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags) @trusted`
	`3053`	`+ ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags) @trusted`
`3054`	`3054`	`{`
`3055`	`3055`	`static if (is(typeof(MSG_NOSIGNAL)))`
`3056`	`3056`	`{`
`@@ -3065,7 +3065,7 @@ public:`
`3065`	`3065`
`3066`	`3066`	`//assumes you connect()ed`
`3067`	`3067`	`/// ditto`
`3068`		`- ptrdiff_t sendTo(const(void)[] buf)`
	`3068`	`+ ptrdiff_t sendTo(scope const(void)[] buf)`
`3069`	`3069`	`{`
`3070`	`3070`	`return sendTo(buf, SocketFlags.NONE);`
`3071`	`3071`	`}`
`@@ -3077,7 +3077,7 @@ public:`
`3077`	`3077`	* Returns: The number of bytes actually received, `0` if the remote side
`3078`	`3078`	* has closed the connection, or `Socket.ERROR` on failure.
`3079`	`3079`	`*/`
`3080`		`- ptrdiff_t receive(void[] buf, SocketFlags flags) @trusted`
	`3080`	`+ ptrdiff_t receive(scope void[] buf, SocketFlags flags) @trusted`
`3081`	`3081`	`{`
`3082`	`3082`	`version (Windows) // Does not use size_t`
`3083`	`3083`	`{`
`@@ -3094,7 +3094,7 @@ public:`
`3094`	`3094`	`}`
`3095`	`3095`
`3096`	`3096`	`/// ditto`
`3097`		`- ptrdiff_t receive(void[] buf)`
	`3097`	`+ ptrdiff_t receive(scope void[] buf)`
`3098`	`3098`	`{`
`3099`	`3099`	`return receive(buf, SocketFlags.NONE);`
`3100`	`3100`	`}`
`@@ -3106,7 +3106,7 @@ public:`
`3106`	`3106`	* Returns: The number of bytes actually received, `0` if the remote side
`3107`	`3107`	* has closed the connection, or `Socket.ERROR` on failure.
`3108`	`3108`	`*/`
`3109`		`- ptrdiff_t receiveFrom(void[] buf, SocketFlags flags, ref Address from) @trusted`
	`3109`	`+ ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags, ref Address from) @trusted`
`3110`	`3110`	`{`
`3111`	`3111`	`if (!buf.length) //return 0 and don't think the connection closed`
`3112`	`3112`	`return 0;`
`@@ -3129,15 +3129,15 @@ public:`
`3129`	`3129`
`3130`	`3130`
`3131`	`3131`	`/// ditto`
`3132`		`- ptrdiff_t receiveFrom(void[] buf, ref Address from)`
	`3132`	`+ ptrdiff_t receiveFrom(scope void[] buf, ref Address from)`
`3133`	`3133`	`{`
`3134`	`3134`	`return receiveFrom(buf, SocketFlags.NONE, from);`
`3135`	`3135`	`}`
`3136`	`3136`
`3137`	`3137`
`3138`	`3138`	`//assumes you connect()ed`
`3139`	`3139`	`/// ditto`
`3140`		`- ptrdiff_t receiveFrom(void[] buf, SocketFlags flags) @trusted`
	`3140`	`+ ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags) @trusted`
`3141`	`3141`	`{`
`3142`	`3142`	`if (!buf.length) //return 0 and don't think the connection closed`
`3143`	`3143`	`return 0;`
`@@ -3158,7 +3158,7 @@ public:`
`3158`	`3158`
`3159`	`3159`	`//assumes you connect()ed`
`3160`	`3160`	`/// ditto`
`3161`		`- ptrdiff_t receiveFrom(void[] buf)`
	`3161`	`+ ptrdiff_t receiveFrom(scope void[] buf)`
`3162`	`3162`	`{`
`3163`	`3163`	`return receiveFrom(buf, SocketFlags.NONE);`
`3164`	`3164`	`}`
`@@ -3169,7 +3169,7 @@ public:`
`3169`	`3169`	* Returns: The number of bytes written to `result`.
`3170`	`3170`	`* The length, in bytes, of the actual result - very different from getsockopt()`
`3171`	`3171`	`*/`
`3172`		`- int getOption(SocketOptionLevel level, SocketOption option, void[] result) @trusted`
	`3172`	`+ int getOption(SocketOptionLevel level, SocketOption option, scope void[] result) @trusted`
`3173`	`3173`	`{`
`3174`	`3174`	`socklen_t len = cast(socklen_t) result.length;`
`3175`	`3175`	`if (_SOCKET_ERROR == .getsockopt(sock, cast(int) level, cast(int) option, result.ptr, &len))`
`@@ -3217,7 +3217,7 @@ public:`
`3217`	`3217`	`}`
`3218`	`3218`
`3219`	`3219`	`/// Set a socket option.`
`3220`		`- void setOption(SocketOptionLevel level, SocketOption option, void[] value) @trusted`
	`3220`	`+ void setOption(SocketOptionLevel level, SocketOption option, scope void[] value) @trusted`
`3221`	`3221`	`{`
`3222`	`3222`	`if (_SOCKET_ERROR == .setsockopt(sock, cast(int) level,`
`3223`	`3223`	`cast(int) option, value.ptr, cast(uint) value.length))`
`@@ -3647,55 +3647,55 @@ class UdpSocket: Socket`
`3647`	`3647`	`{`
`3648`	`3648`	`checkAttributes!q{@trusted}; assert(0);`
`3649`	`3649`	`}`
`3650`		`- @trusted ptrdiff_t send(const(void)[] buf, SocketFlags flags)`
	`3650`	`+ @trusted ptrdiff_t send(scope const(void)[] buf, SocketFlags flags)`
`3651`	`3651`	`{`
`3652`	`3652`	`checkAttributes!q{@trusted}; assert(0);`
`3653`	`3653`	`}`
`3654`		`- @safe ptrdiff_t send(const(void)[] buf)`
	`3654`	`+ @safe ptrdiff_t send(scope const(void)[] buf)`
`3655`	`3655`	`{`
`3656`	`3656`	`checkAttributes!q{@safe}; assert(0);`
`3657`	`3657`	`}`
`3658`		`- @trusted ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags, Address to)`
	`3658`	`+ @trusted ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags, Address to)`
`3659`	`3659`	`{`
`3660`	`3660`	`checkAttributes!q{@trusted}; assert(0);`
`3661`	`3661`	`}`
`3662`		`- @safe ptrdiff_t sendTo(const(void)[] buf, Address to)`
	`3662`	`+ @safe ptrdiff_t sendTo(scope const(void)[] buf, Address to)`
`3663`	`3663`	`{`
`3664`	`3664`	`checkAttributes!q{@safe}; assert(0);`
`3665`	`3665`	`}`
`3666`		`- @trusted ptrdiff_t sendTo(const(void)[] buf, SocketFlags flags)`
	`3666`	`+ @trusted ptrdiff_t sendTo(scope const(void)[] buf, SocketFlags flags)`
`3667`	`3667`	`{`
`3668`	`3668`	`checkAttributes!q{@trusted}; assert(0);`
`3669`	`3669`	`}`
`3670`		`- @safe ptrdiff_t sendTo(const(void)[] buf)`
	`3670`	`+ @safe ptrdiff_t sendTo(scope const(void)[] buf)`
`3671`	`3671`	`{`
`3672`	`3672`	`checkAttributes!q{@safe}; assert(0);`
`3673`	`3673`	`}`
`3674`		`- @trusted ptrdiff_t receive(void[] buf, SocketFlags flags)`
	`3674`	`+ @trusted ptrdiff_t receive(scope void[] buf, SocketFlags flags)`
`3675`	`3675`	`{`
`3676`	`3676`	`checkAttributes!q{@trusted}; assert(0);`
`3677`	`3677`	`}`
`3678`		`- @safe ptrdiff_t receive(void[] buf)`
	`3678`	`+ @safe ptrdiff_t receive(scope void[] buf)`
`3679`	`3679`	`{`
`3680`	`3680`	`checkAttributes!q{@safe}; assert(0);`
`3681`	`3681`	`}`
`3682`		`- @trusted ptrdiff_t receiveFrom(void[] buf, SocketFlags flags, ref Address from)`
	`3682`	`+ @trusted ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags, ref Address from)`
`3683`	`3683`	`{`
`3684`	`3684`	`checkAttributes!q{@trusted}; assert(0);`
`3685`	`3685`	`}`
`3686`		`- @safe ptrdiff_t receiveFrom(void[] buf, ref Address from)`
	`3686`	`+ @safe ptrdiff_t receiveFrom(scope void[] buf, ref Address from)`
`3687`	`3687`	`{`
`3688`	`3688`	`checkAttributes!q{@safe}; assert(0);`
`3689`	`3689`	`}`
`3690`		`- @trusted ptrdiff_t receiveFrom(void[] buf, SocketFlags flags)`
	`3690`	`+ @trusted ptrdiff_t receiveFrom(scope void[] buf, SocketFlags flags)`
`3691`	`3691`	`{`
`3692`	`3692`	`checkAttributes!q{@trusted}; assert(0);`
`3693`	`3693`	`}`
`3694`		`- @safe ptrdiff_t receiveFrom(void[] buf)`
	`3694`	`+ @safe ptrdiff_t receiveFrom(scope void[] buf)`
`3695`	`3695`	`{`
`3696`	`3696`	`checkAttributes!q{@safe}; assert(0);`
`3697`	`3697`	`}`
`3698`		`- @trusted int getOption(SocketOptionLevel level, SocketOption option, void[] result)`
	`3698`	`+ @trusted int getOption(SocketOptionLevel level, SocketOption option, scope void[] result)`
`3699`	`3699`	`{`
`3700`	`3700`	`checkAttributes!q{@trusted}; assert(0);`
`3701`	`3701`	`}`
`@@ -3711,7 +3711,7 @@ class UdpSocket: Socket`
`3711`	`3711`	`{`
`3712`	`3712`	`checkAttributes!q{@trusted};`
`3713`	`3713`	`}`
`3714`		`- @trusted void setOption(SocketOptionLevel level, SocketOption option, void[] value)`
	`3714`	`+ @trusted void setOption(SocketOptionLevel level, SocketOption option, scope void[] value)`
`3715`	`3715`	`{`
`3716`	`3716`	`checkAttributes!q{@trusted};`
`3717`	`3717`	`}`
`@@ -3793,11 +3793,11 @@ Socket[2] socketPair() @trusted`
`3793`	`3793`	`///`
`3794`	`3794`	`@safe unittest`
`3795`	`3795`	`{`
`3796`		`- immutable ubyte[] data = [1, 2, 3, 4];`
	`3796`	`+ immutable ubyte[4] data = [1, 2, 3, 4];`
`3797`	`3797`	`auto pair = socketPair();`
`3798`	`3798`	`scope(exit) foreach (s; pair) s.close();`
`3799`	`3799`
`3800`		`- pair[0].send(data);`
	`3800`	`+ pair[0].send(data[]);`
`3801`	`3801`
`3802`	`3802`	`auto buf = new ubyte[data.length];`
`3803`	`3803`	`pair[1].receive(buf);`