Add EventLoop::FileDescriptor module
#14639
Conversation
| # Reads at least one byte from the file descriptor into *slice* and continues | ||
| # fiber when the read is complete. | ||
| # Returns the number of bytes read. | ||
| abstract def read(file_descriptor : Crystal::System::FileDescriptor, slice : Bytes) : Int32 |
There was a problem hiding this comment.
suggestion: maybe explicit both the blocking and EOF behaviors?
Reads at least one byte from the file descriptor into slice.
Blocks the current fiber if no data is available for reading, otherwise returns immediately.
Returns the number of bytes read (up to slice.size).
Returns 0 when EOF is reached.
There was a problem hiding this comment.
Yeah I think that's better 👍
Btw. these descriptions have been up for review in crystal-lang/rfcs#7 😏
Maybe you want to take a look at the other there ones as well?
| # Writes at least one byte from *slice* to the file descriptor and continues | ||
| # fiber when the write is complete. | ||
| # Returns the number of bytes written. | ||
| abstract def write(file_descriptor : Crystal::System::FileDescriptor, slice : Bytes) : Int32 |
There was a problem hiding this comment.
suggestion: same and "when the write is complete" can be ambiguous (writes fully?)
Writes at least one byte from slice to the file descriptor.
Blocks the current fiber if the file descriptor isn't ready for writing, otherwise returns immediately.
Returns the number of bytes written (up to slice.size).
| @@ -131,14 +111,14 @@ module Crystal::System::FileDescriptor | |||
| # Mark the handle open, since we had to have dup'd a live handle. | |||
| @closed = false | |||
|
|
|||
| evented_reopen | |||
| event_loop.close(self) | |||
There was a problem hiding this comment.
I was going to propose to remove IO::Evented#evented_reopen, but then I realize this is part of the public API somehow. Maybe deprecate?
There was a problem hiding this comment.
Oh good point. Actually, all evented_* methods are documented API: https://crystal-lang.org/api/1.12.1/IO/Evented.html 🤦
I'm pretty sure this is totally unintended. Nobody should need to call these methods directly from user code.
There was a problem hiding this comment.
yes, this is what I mean with "public". I guess we can deprecate all of it...
There was a problem hiding this comment.
Eventually, everything from IO::Evented has to be removed, because it's event-loop specific implementation. These methods will need to be moved to the event loop implementation. Same for IO::Overlapped (which is thankfully nodoc).
|
The methods in the wasi interface are new, should they be tested? |
|
@beta-ziliani Not sure what you mean which methods would need to be tested on Wasi? |
|
I guess I'm missing the part in which WASI uses unix/file_descriptor.cr. But in this case, doesn't it make sense to abstract these two instead of copying it? |
|
WASI event loop and libevent are completely different things. |
Extracts the system interface for
FileDescriptoroperations on the event loop to aEventLoopmodule.This implements part of crystal-lang/rfcs#7
Related: #14643 does the same for
Socket