Class: URI::File (Ruby 2.7.3)
Description: Class : URI::File - Ruby 2.7.3

### Home Classes Methods

### In Files

- uri/file.rb

### Parent

Generic

### Methods

- ::build
- #check_password
- #check_user
- #check_userinfo
- #set_host
- #set_password
- #set_port
- #set_user
- #set_userinfo

### Class/Module Index

Quicksearch

- Kernel
- URI
- URI::BadURIError
- URI::Error
- URI::Escape
- URI::FTP
- URI::File
- URI::Generic
- URI::HTTP
- URI::HTTPS
- URI::InvalidComponentError
- URI::InvalidURIError
- URI::LDAP
- URI::LDAPS
- URI::MailTo
- URI::Parser
- URI::REGEXP
- URI::RFC2396_Parser
- URI::RFC2396_REGEXP
- URI::RFC2396_REGEXP::PATTERN

No matching classes.

# 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

build(args) click to toggle source

## 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"

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

### Public Instance Methods

check_password(user) click to toggle source

raise `InvalidURIError`

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

check_user(user) click to toggle source

raise `InvalidURIError`

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

check_userinfo(user) click to toggle source

raise `InvalidURIError`

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

set_host(v) click to toggle source

Protected setter for the host component `v`.

See also `URI::Generic.host=`.

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

set_password(v) click to toggle source

do nothing

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

set_port(v) click to toggle source

do nothing

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

set_user(v) click to toggle source

do nothing

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

set_userinfo(v) click to toggle source

do nothing

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