Add native-descriptor description

Raku · Dec 16, 2015 · 4883a73 · 4883a73
1 parent 77518c1
commit 4883a73
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/doc/Type/IO/Handle.pod b/doc/Type/IO/Handle.pod
@@ -168,6 +168,14 @@ Will flush the filehandle to disk.
 
     $fh.flush;
 
+=head2 method native-descriptor
+
+    method native-descriptor()
+
+This returns a value that the operating system would understand as a "file descriptor" and
+is suitable for passing to a native function that requires a file descriptor as an
+argument such as C<fcntl> or C<ioctl>. 
+
 =head1 Related roles and classes
 
 See also the related role L<IO> and the related class L<IO::Path>.

diff --git a/doc/Type/IO/Socket.pod b/doc/Type/IO/Socket.pod
@@ -56,4 +56,12 @@ Closes the socket.
 
 Fails if the socket is not connected.
 
+=head2 method native-descriptor
+
+    method native-descriptor()
+
+This returns a value that the operating system would understand as a "socket descriptor" and
+is suitable for passing to a native function that requires a socket descriptor as an
+argument such as C<setsockopt>.
+
 =end pod