Skip to content

Document the link function's error conditions. #165

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

Merged
merged 2 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -1157,6 +1157,9 @@ WASI.</p>
</ul>
<h4><a id="method_descriptor_link_at"></a><code>[method]descriptor.link-at: func</code></h4>
<p>Create a hard link.</p>
<p>Fails with <a href="#error_code.no_entry"><code>error-code::no-entry</code></a> if the old path does not exist,
with <a href="#error_code.exist"><code>error-code::exist</code></a> if the new path already exists, and
<a href="#error_code.not_permitted"><code>error-code::not-permitted</code></a> if the old path is not a file.</p>
<p>Note: This is similar to <code>linkat</code> in POSIX.</p>
<h5>Params</h5>
<ul>
Expand Down
4 changes: 4 additions & 0 deletions wit/types.wit
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,10 @@ interface types {

/// Create a hard link.
///
/// Fails with `error-code::no-entry` if the old path does not exist,
/// with `error-code::exist` if the new path already exists, and
/// `error-code::not-permitted` if the old path is not a file.
///
/// Note: This is similar to `linkat` in POSIX.
@since(version = 0.2.0)
link-at: func(
Expand Down
Loading