matfile — Create a Level-5 MAT-file whole-variable compatibility object.
matfile(filename) returns a matlab.io.MatFile object. m.Properties reports Source and Writable; m.A reads a complete variable. Construct with matfile(filename, 'Writable', true) to enable whole-variable dot assignments.
Syntax
m = matfile(filename)
m = matfile(filename, 'Writable', tf)
m = matfile(filename, 'Writable', tf, ...)Inputs
filename- Type
StringScalar- Required
- Yes
- Default
"matlab.mat"- Description
- Level-5 MAT-file path.
option- Type
StringScalar- Required
- Yes
- Description
- Supported MAT selection or save option.
tf- Type
Any- Required
- Yes
- Description
- Scalar logical or numeric writable flag.
tf- Type
Any- Required
- Yes
- Description
- Scalar writable flag.
repeatedNameValue- Type
Any- Required
- Variadic
- Description
- Further complete Writable name-value pairs; the last value wins.
Returns
m- Type
Any- Description
- Session-bound matlab.io.MatFile compatibility object.
Errors
RunMat:matfile:InvalidArgument- When
- Arguments are not a supported matfile form or the receiver is invalid.
- Message
matfile: invalid argument
RunMat:matfile:InvalidOption- When
- Writable name-value controls are invalid.
- Message
matfile: invalid option
RunMat:matfile:Io- When
- MAT-file data cannot be read or written.
- Message
matfile: MAT-file I/O failure
Construction and ownership
The filename is scalar character or string text and gains .mat when no extension is present. Writable accepts a scalar logical or numeric value; omitted means false. Complete repeated Writable pairs are accepted and the last value wins. The object retains the selected filesystem provider and resolved source path across later calls, even if the ambient provider or working folder changes. Public Source and Writable properties report state but do not authorize or retarget I/O.
Reads and writes
Dot reads decode a complete variable with the same Level-5 classes and host-resident results as load. Writable dot assignment reads existing variables, replaces or appends a whole value, and writes the refreshed Level-5 file. A read-only object rejects assignment.
Partial reads/writes that avoid materializing a whole variable, HDF5-backed v7.3 MAT files, and who(m)/whos(m) are not yet supported. The object is session-bound in runtime calls and cannot be forged from public class or property text.
Examples
Read a whole variable
A = [1 2; 3 4];
save('data.mat', 'A');
m = matfile('data.mat');
loaded = m.AExpected output:
A contains the variable loaded from data.mat.Write whole variables
m = matfile('data.mat', 'Writable', true);
m.A = ones(3);
m.flag = true;
S = load('data.mat')Expected output:
The MAT-file is rewritten with updated whole variables.Using matfile with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how matfile changes the result.
Run a small matfile example, explain the result, then change one input and compare the output.
FAQ
Does matfile read part of a variable?⌄
No. The current Level-5 object implementation loads and writes complete variables; partial indexed I/O is not implemented.
Can a read-only object write?⌄
No. Construct with the Writable name-value pair set to a truthy scalar logical or numeric value.
What are m.Properties fields?⌄
Source keeps the normalized caller path spelling (adding .mat when needed), while Writable reports the selected Boolean mode. The private I/O owner separately retains the captured absolute path.
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 · rmdir · 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 matfile is executed, line by line, in Rust.
- View the source for matfile 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.