Skip to content
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.

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

Add thread-safety comments to kdoc #393

Open
vdshb opened this issue Sep 22, 2024 · 0 comments · Fixed by #395
Open

Add thread-safety comments to kdoc #393

vdshb opened this issue Sep 22, 2024 · 0 comments · Fixed by #395
Labels

Comments

@vdshb
Copy link

vdshb commented Sep 22, 2024

I couldn't find any documentation about thread-safety of any class/interface in kotlinx-io.

I am particularly interested in in thread safety of Sink::write from SystemFileSystem.sink().buffered(), but I believe it would be beneficial to add explicit remarks into kdoc about thread-safety of Sink, Source, Buffer, etc.

@fzhinkin fzhinkin added the doc label Sep 22, 2024
fzhinkin added a commit that referenced this issue Sep 23, 2024
Explicitly documents thread-safety guarantees, PeelSource behavior and FileSystem support for JS-target.

Closes #392, #393, #394
fzhinkin added a commit that referenced this issue Sep 23, 2024
* Improve documentation

Explicitly document thread-safety guarantees, PeekSource behavior and FileSystem support for JS-target.

Closes #392, #393, #394
@fzhinkin fzhinkin linked a pull request Sep 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants