Docs4dev
Docs
ruby / 3.1 / uri / file.html

class URI::File

Parent:
Generic

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

build(args) Show source 
# File lib/uri/file.rb, line 47
def self.build(args)
  tmp = Util::make_components_hash(self, args)
  super(tmp)
end

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].

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"
Calls superclass method

Public Instance Methods

check_password(user) Show source 
# File lib/uri/file.rb, line 76
def check_password(user)
  raise URI::InvalidURIError, "can not set password for file URI"
end

raise InvalidURIError

check_user(user) Show source 
# File lib/uri/file.rb, line 71
def check_user(user)
  raise URI::InvalidURIError, "can not set user for file URI"
end

raise InvalidURIError

check_userinfo(user) Show source 
# File lib/uri/file.rb, line 66
def check_userinfo(user)
  raise URI::InvalidURIError, "can not set userinfo for file URI"
end

raise InvalidURIError

set_host(v) Show source 
# File lib/uri/file.rb, line 56
def set_host(v)
  v = "" if v.nil? || v == "localhost"
  @host = v
end

Protected setter for the host component v.

See also URI::Generic.host=.

set_password(v) Show source 
# File lib/uri/file.rb, line 89
def set_password(v)
end

do nothing

set_port(v) Show source 
# File lib/uri/file.rb, line 62
def set_port(v)
end

do nothing

set_user(v) Show source 
# File lib/uri/file.rb, line 85
def set_user(v)
end

do nothing

set_userinfo(v) Show source 
# File lib/uri/file.rb, line 81
def set_userinfo(v)
end

do nothing

Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.