Skip to content

Add scope decorations to std.socket #8438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thewilsonator merged 1 commit into from
May 7, 2022
Merged

Add scope decorations to std.socket #8438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions changelog/scopesocket.dd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
60 changes: 30 additions & 30 deletions std/socket.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)))
{
Expand All @@ -3014,7 +3014,7 @@ public:
}

/// ditto
ptrdiff_t send(const(void)[] buf)
ptrdiff_t send(scope const(void)[] buf)
{
return send(buf, SocketFlags.NONE);
}
Expand All @@ -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)))
{
Expand All @@ -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)))
{
Expand All @@ -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);
}
Expand All @@ -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
{
Expand All @@ -3094,7 +3094,7 @@ public:
}

/// ditto
ptrdiff_t receive(void[] buf)
ptrdiff_t receive(scope void[] buf)
{
return receive(buf, SocketFlags.NONE);
}
Expand All @@ -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;
Expand All @@ -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;
Expand All @@ -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);
}
Expand All @@ -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))
Expand Down Expand Up @@ -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))
Expand Down Expand Up @@ -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);
}
Expand All @@ -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};
}
Expand Down Expand Up @@ -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);
Expand Down