fileread — Read an entire file into a character row.
fileread(filename) reads a host text file and returns its decoded content as a 1-by-N character array. An optional encoding can be passed positionally or as an Encoding name-value pair; invalid controls fail before file access.
Syntax
text = fileread(filename)
text = fileread(filename, encoding)
text = fileread(filename, "Encoding", encoding)Inputs
filename- Type
Any- Required
- Yes
- Description
- Path to a readable file.
encoding- Type
StringScalar- Required
- No
- Default
"auto"- Description
- Encoding label (for example 'utf-8', 'latin1', 'ascii', 'raw').
name- Type
PropertyName- Required
- No
- Default
"Encoding"- Description
- Name of supported option; currently only 'Encoding'.
value- Type
PropertyValue- Required
- No
- Default
"auto"- Description
- Option value for the provided option name.
Returns
text- Type
Any- Description
- File contents as a 1-by-N character vector.
Errors
RunMat:fileread:InvalidInput- When
- Filename or argument cardinality/type constraints are violated.
- Message
fileread: invalid input arguments
RunMat:fileread:InvalidOption- When
- Encoding option syntax or value is invalid.
- Message
fileread: invalid option configuration
RunMat:fileread:DecodeFailed- When
- Requested decoding of bytes fails (for example UTF-8 or ASCII mismatch).
- Message
fileread: unable to decode file contents
Paths, encoding, and output
The filename must be a scalar string or one-row character vector; a string array must have exactly one element. Relative paths use the RunMat process working directory. Bare-name MATLAB search-path lookup is not implemented. A missing or unreadable file raises a filesystem error.
An empty file yields a 1-by-0 character row. CR, LF, and CRLF line endings are preserved. The default auto decoder tries UTF-8 and, on invalid UTF-8, maps each byte to its corresponding extended-ASCII code point. Explicit utf-8 and ascii report incompatible bytes, while latin1 and the RunMat raw/bytes alias map bytes one-for-one.
fileread(filename, encoding) and fileread(filename, 'Encoding', encoding) accept auto, utf-8, ascii, latin1, and raw labels with documented aliases. The input is host text; numeric or provider-resident filename and encoding controls are not gathered and are rejected before filesystem effects.
Execution and resource ownership
The installed filesystem service supplies the bytes; the result is host character storage. There is no GPU kernel or fusion path. Browser execution requires a real installed file service and appropriate permissions.
The current reader materializes the file bytes before decoding, so large files can require substantial host memory in addition to the returned character array.
Examples
Read the entire file
text = fileread('license.txt');
textExpected output:
text = Terms
Line twoRead a relative path
text = fileread('data/config.json');
textExpected output:
text = {"enabled":true}Preserve extended ASCII bytes
text = fileread('high_ascii.txt', 'raw');
codes = double(text);
codesConvert the result to a string scalar
raw = fileread('readme.txt');
doc = string(raw);
docDecode UTF-8 explicitly
text = fileread('data/report.txt', 'Encoding', 'utf-8');
textReport a missing file
fileread('missing.txt');Using fileread with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how fileread changes the result.
Run a small fileread example, explain the result, then change one input and compare the output.
FAQ
What does fileread return?⌄
A 1-by-N character vector, including a 1-by-0 row for an empty file. Use string(...) to convert it.
Does it change line endings?⌄
No. Original CR, LF, and CRLF characters remain in the returned text.
Can it read raw bytes?⌄
The RunMat raw/bytes encoding alias maps each input byte to one character code point; the compatible primary form is text-oriented.
How does auto decoding work?⌄
It tries UTF-8 first, then maps each byte to an extended-ASCII code point if UTF-8 is invalid. Explicit UTF-8 and ASCII reject incompatible input.
How do relative paths resolve?⌄
Against the process working directory, not through bare-name MATLAB search-path lookup.
Related Io functions
Filetext
fclose · feof · fgetl · fgets · filewrite · fopen · fprintf · fread · frewind · fwrite · readlines · writelines
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
Import
Json
Source you can read
Every RunMat function's source is public. Read exactly how fileread is executed, line by line, in Rust.
- View the source for fileread 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.