Pudu programming language
Menu
API reference

Std.Fs.rename

1 declaration

fn

rename: Str -> Str -> Result[(), Std.Fs.FsError]

This is a callable function.

What it does

A path renamed, replacing whatever the destination held.

On one filesystem the destination names either the old contents or the new,

never a mixture, which is what makes writeAtomically possible.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Result makes success and recoverable failure part of the function's type.

Back to Std.FsSearch related declarations