This built-in predicate renames a source file to a destination file, the destination file may not already exist. The source and destination files must be on the same physical device.
see also: app_dir/1 base64_decode_file/2 base64_encode_file/2 compress_file/2 copy_file/2 current_dir/1 decompress_file/1 decompress_file/2 decrypt_file/3 delete_file/1 encrypt_file/3 exists_dir/1 exists_file/1 info_file/2 make_dir/1 md5_file/2 next_file/2 next_file/3 next_dir/2 remove_dir/1 set_current_dir/1 split_fn/2 unlink_file/1 wipe_file/1
| Examples | |
| rename_file('c:\\temp\\doc.txt', 'c:\\temp\\doc2.txt'). | the file 'doc.txt' is renamed from 'c:\temp\' to 'c:\temp\doc2.txt' |
| Exceptions | |
| The argument is an empty variable | an instantiation_error exception is thrown |
| The argument Arg is not an atom enclosed by single or double quotes | a type_error(atom_singlequotes, Arg) exception is thrown |
| The File to cannot be rename does not exist | an existence_error(file, File) exception is thrown |
| The destination File already exists | a permission_error(write, file, File) exception is thrown |
| The two files are not on the same device | a system_error(different, devices, A) exception is thrown |