mlreportgen.utils.fileToURI

Convert file path to Universal Resource Identifier

Syntax

uri = mlreportgen.utils.fileToURI(filename)

Description

uri = mlreportgen.utils.fileToURI(filename) converts filename to a Universal Resource Identifier (URI).

URIs are strings that specify the name of a file and the path to that file. URIs allow access to a resource over a network. Web addresses (URLs) are a type of URI. For more information about URIs, see the URI specification at the World Wide Web Consortium website.

Examples

Convert File Name to URI

uri = mlreportgen.utils.fileToURI...
   ("C:/Users/jsmith/Desktop/200-C Form.pdf")

uri = 

    "file:///C:/Users/jsmith/Desktop/200-C%20Form.pdf"

Input Arguments

filename — Name or full path of file to convert

character vector | string scalar

Name or full path of the file to convert, specified as a character vector or string scalar. For a full list of unencoded, reserved, and encoded ASCI characters, see More About.

Output Arguments

uri — Universal Resource Identifier

character vector | string scalar

URI of the file, returned as a character vector or string scalar.

More About

Reserved Characters

Reserved characters have special meanings to file and web servers and may cause errors when included in a file path. The reserved characters are: :, /. If a file name includes reserved characters, mlreportgen.utils.fileToURI does not percent-encode them.

For example, if the file name is:

C:/Users/jsmith/Desktop/Report@Store1

The encoded URI is:

C:/Users/jsmith/Desktop/Report@Store1

If you have an error or warning with a path containing one of these characters, remove or replace the character in the path.

Unencoded ASCII Characters

mlreportgen.utils.fileToURI does not encode these alphanumeric or unreserved characters:

• Alphanumeric characters: A–Z, a–z, 0–9

• Unreserved characters: -, _, ., ~

For example, if the file name is:

C:/Users/jsmith/Desktop/My_Report

The encoded URI is:

C:/Users/jsmith/Desktop/My_Report

Unsafe Characters

Unsafe characters either have reserved meanings in the URI standard or will disrupt parsing when they are not encoded properly, for example being misinterpreted as delimiters. To ensure interoperability and reduce injection vulnerabilities, the URI standard specifies percent-encoding unsafe characters. mlreportgen.utils.fileToURI applies percent-encoding to these characters.

• Space, !, ", #, $, %, &, ', (, ), +, ,,;, <, =, >, ?, @, [, \, ], ^, `, {, }, Control characters: ASCII 0–31, 127

For example, if the file name is:

C:/Users/jsmith/Desktop/My Report #1.docx

The encoded URI is:

C:/Users/jsmith/Desktop/My%20Report%20%231.docx"

For a list of ASCII characters values, see https://en.wikipedia.org/wiki/ASCII#Table_of_codes.

Non-ASCII characters

mlreportgen.utils.fileToURI encodes all non-ASCII characters by applying UTF-8 and then percent-encoding.

For example, if the file name is:

C:/Users/jsmith/Desktop/Élodie Dufrêne Bio.pdf

The encoded URI is:

C:/Users/jsmith/Desktop/%C3%89lodie%20Dufr%C3%AAne%20Bio.pdf

Version History

Introduced in R2018b