tomo-Path.move.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.move 3 2026-03-14 "Tomo man-pages"
   6 .SH NAME
   7 Path.move \- move a file or directory
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.move\ :\ func(path:\ Path,\ dest:\ Path,\ allow_overwriting\ =\ no\ ->\ Result)
  13 .fi
  14 .SH DESCRIPTION
  15 Moves the file or directory from one location to another.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 path	Path	The path to move. 	-
  26 dest	Path	The destination to move the path to. 	-
  27 allow_overwriting		Whether to permit overwriting the destination if it is an existing file or directory. 	no
  28 .TE
  29 .SH RETURN
  30 Either `Success` or `Failure(reason)`.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 (./file.txt).move(/tmp/renamed.txt)!
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)