code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.create_directory 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Path.create_directory \- make a directory
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.create_directory\ :\ func(path:\ Path,\ permissions\ =\ Int32(0o755),\ recursive\ =\ yes\ ->\ Result)
  13 .fi
  14 .SH DESCRIPTION
  15 Creates a new directory at the specified path with the given permissions. If any of the parent directories do not exist, they will be created as needed.
  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 of the directory to create. 	-
  26 permissions		The permissions to set on the new directory. 	Int32(0o755)
  27 recursive		If set to \fByes\fR, then recursively create any parent directories if they don't exist, otherwise fail if the parent directory does not exist. When set to \fByes\fR, this function behaves like \fBmkdir -p\fR. 	yes
  28 .TE
  29 .SH RETURN
  30 Either `Success` or `Failure(reason)`.
  31 
  32 .SH NOTES
  33 
  34 .SH EXAMPLES
  35 .EX
  36 (./new_directory).create_directory()!
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Path (3)