class URI::File

The “file” URI is defined by RFC8089.

Constants

COMPONENT: An Array of the available components for URI::File.
DEFAULT_PORT: A Default port of nil for URI::File.

Public Class Methods

(Array[String] args) → URI::File
({ host: String?, path: String? }) → URI::File

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 49
def self.build: (Array[String] args) -> URI::File
                  | ({ host: String?, path: String? }) -> URI::File

Description

Creates a new URI::File object from components, with syntax checking.

The components accepted are host and path.

The components should be provided either as an Array, or as a Hash with keys formed by preceding the component names with a colon.

If an Array is used, the components must be passed in the order [host, path].

A path from e.g. the File class should be escaped before being passed.

Examples:

require 'uri'

uri1 = URI::File.build(['host.example.com', '/path/file.zip'])
uri1.to_s  # => "file://host.example.com/path/file.zip"

uri2 = URI::File.build({:host => 'host.example.com',
  :path => '/ruby/src'})
uri2.to_s  # => "file://host.example.com/ruby/src"

uri3 = URI::File.build({:path => URI::RFC2396_PARSER.escape('/path/my file.txt')})
uri3.to_s  # => "file:///path/my%20file.txt"

Public Instance Methods

check_password

(String user) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 92
def check_password: (String user) -> nil

raise InvalidURIError

check_user

(String user) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 84
def check_user: (String user) -> nil

raise InvalidURIError

check_userinfo

(String user) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 76
def check_userinfo: (String user) -> nil

raise InvalidURIError

set_host

(String? v) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 60
def set_host: (String? v) -> String

Protected setter for the host component v.

See also URI::Generic.host=.

set_password

(String v) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 116
def set_password: (String v) -> nil

do nothing

set_port

(Integer v) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 68
def set_port: (Integer v) -> nil

do nothing

set_user

(String v) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 108
def set_user: (String v) -> nil

do nothing

set_userinfo

(String v) → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/uri/0/file.rbs, line 100
def set_userinfo: (String v) -> nil

do nothing