rmdir — Remove directories with optional recursion and symbolic-link resolution.
rmdir removes a directory through the active filesystem service and provides logical status with optional diagnostics.
Syntax
[status, msg, msgID] = rmdir(folderName)
[status, msg, msgID] = rmdir(folderName, 's')
[status, msg, msgID] = rmdir(___, ResolveSymbolicLinks=tf)
[status, msg, msgID] = rmdir(folderName, 's', ResolveSymbolicLinks=tf)Inputs
folderName- Type
StringScalar- Required
- Yes
- Description
- Folder path to remove.
s- Type
StringScalar- Required
- Yes
- Default
's'- Description
- Recursive-removal flag.
ResolveSymbolicLinks- Type
PropertyName- Required
- Yes
- Description
- Symbolic-link resolution option name.
tf- Type
Any- Required
- Yes
- Default
false- Description
- Logical or exact numeric scalar zero or one.
Returns
status- Type
LogicalArray- Description
- Logical true when removal succeeds.
msg- Type
StringScalar- Description
- Character-row diagnostic, empty after success.
msgID- Type
StringScalar- Description
- Character-row diagnostic identifier.
Returned values from rmdir depend on how many outputs the caller requests.
Errors
RunMat:rmdir:InvalidArgumentCount- When
- The call has no folder or has unsupported trailing arguments.
- Message
rmdir: invalid input arguments
RunMat:rmdir:InvalidFolder- When
- The folder is not a character row or string scalar.
- Message
rmdir: folder name must be a character vector or string scalar
RunMat:rmdir:InvalidOption- When
- The recursive flag or symbolic-link option is malformed.
- Message
rmdir: invalid recursive or symbolic-link option
Remove directories
rmdir(folderName) removes an empty directory. Add 's' to remove its descendants recursively. With outputs, the logical status reports success and msg and msgID are empty character rows after a successful removal.
Operational failures return logical false and diagnostics when outputs are requested. Without outputs, they raise an error so a failed removal cannot pass silently.
Symbolic links and execution
ResolveSymbolicLinks=false removes a symbolic link itself and leaves its target in place. ResolveSymbolicLinks=true removes the resolved target and leaves the link. The option accepts logical scalars and exact numeric zero or one; it may follow the optional 's' flag.
The 's' flag and ResolveSymbolicLinks option name are case-insensitive. Relative paths use the current folder, a leading ~ expands through the active environment, and native Windows paths may use drive-letter or UNC syntax.
Removal runs through the host or browser filesystem service and is never sent to an acceleration provider. Folder and option names must be host text. A provider-resident ResolveSymbolicLinks control is gathered only after those names and the option grammar have been validated.
Examples
Remove an empty directory
folder = tempname();
mkdir(folder);
status = rmdir(folder);
existsAfter = exist(folder, 'dir');Expected output:
status is logical true and the folder is absentRemove a directory hierarchy
folder = tempname();
mkdir(folder, fullfile('data', 'archive'));
status = rmdir(folder, 's');
existsAfter = exist(folder, 'dir');Expected output:
status is logical true and the hierarchy is absentCapture an operational failure
folder = tempname();
[status, msg, msgID] = rmdir(folder);Expected output:
status is logical false and diagnostics identify the missing folderPreserve a nonempty directory without recursion
folder = tempname();
mkdir(folder);
fid = fopen(fullfile(folder, 'data.bin'), 'w');
fclose(fid);
[status, msg, msgID] = rmdir(folder);
stillPresent = exist(folder, 'dir');
rmdir(folder, 's');Expected output:
status is logical false and the nonempty directory remainsUse the case-insensitive recursive flag
folder = tempname();
mkdir(folder, 'nested');
status = rmdir(folder, 'S');
existsAfter = exist(folder, 'dir');Expected output:
uppercase S recursively removes the hierarchySupply the symbolic-link policy explicitly
folder = tempname();
mkdir(folder);
status = rmdir(folder, ResolveSymbolicLinks=false);
existsAfter = exist(folder, 'dir');Expected output:
the explicit default policy removes the directoryUsing rmdir with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how rmdir changes the result.
Run a small rmdir example, explain the result, then change one input and compare the output.
FAQ
How do I remove a nonempty directory?⌄
Pass 's' as the second argument. Without it, rmdir leaves the directory unchanged and reports that it is not empty.
Does rmdir follow symbolic links?⌄
Not by default. Set ResolveSymbolicLinks=true when the resolved target, rather than the link entry, should be removed.
Does rmdir throw on a filesystem failure?⌄
A no-output call raises an error. Capture status, message, and message ID to handle the failure programmatically.
Is the recursive flag case-sensitive?⌄
No. Character-row and scalar-string forms of 's' and 'S' select recursive removal.
Why are message and message ID character arrays?⌄
The compatibility interface returns character rows, including 1-by-0 empty rows after success. Convert them explicitly when a string value is needed.
Related Io functions
Repl Fs
addpath · cd · copyfile · delete · dir · exist · fileattrib · fileparts · filesep · fullfile · genpath · getenv · getpref · isenv · isfile · isfolder · ispref · ls · matlabroot · memmapfile · memmapfile.subsasgn · memmapfile.subsref · mkdir · movefile · open · opentoline · path · pathsep · pcode · pwd · readstruct · rehash · restoredefaultpath · rmpath · run · savepath · setenv · setpref · system · tempdir · tempname · uigetdir · uigetfile · uiputfile · unsetenv · userpath · what · winqueryreg · xmlread · xmlwrite
Tabular
arrayDatastore · csvread · csvwrite · detectImportOptions · dlmread · dlmwrite · fileDatastore · getvaropts · parquetDatastore · parquetinfo · parquetread · readcell · readmatrix · readtable · readtimetable · setvaropts · setvartype · spreadsheetImportOptions · writecell · writematrix · writetable · writetimetable · xlsread · xlswrite
Data
commit · data.copy · data.create · data.delete · data.exists · data.export · data.import · data.inspect · data.list · data.move · data.open · DataArray.chunk_shape · DataArray.codec · DataArray.dtype · DataArray.fill · DataArray.name · DataArray.rank · DataArray.read · DataArray.resize · DataArray.shape · DataArray.write · Dataset.array · Dataset.arrays · Dataset.attrs · Dataset.begin · Dataset.get_attr · Dataset.has_array · Dataset.id · Dataset.path · Dataset.refresh · Dataset.set_attr · Dataset.set_attrs · Dataset.snapshot · Dataset.version · DataTransaction.abort · DataTransaction.commit · DataTransaction.create_array · DataTransaction.delete_array · DataTransaction.fill · DataTransaction.id · DataTransaction.resize · DataTransaction.set_attr · DataTransaction.set_attrs · DataTransaction.status · DataTransaction.write
Filetext
fclose · feof · fgetl · fgets · fileread · filewrite · fopen · fprintf · fread · frewind · fwrite · readlines · writelines
Import
Json
Source you can read
Every RunMat function's source is public. Read exactly how rmdir is executed, line by line, in Rust.
- View the source for rmdir in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.