class Bundler::URI::File - bundler: Ruby Standard Library Documentation

# class Bundler::URI::File

The “file” `Bundler::URI` is defined by RFC8089.

### Constants

COMPONENT

  An Array of the available components for `Bundler::URI::File`.

DEFAULT_PORT

  A Default port of nil for `Bundler::URI::File`.

### Public Class Methods

build(args) click to toggle source

## Description¶ ↑

Creates a new `Bundler::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 'bundler/vendor/uri/lib/uri'

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

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

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

Calls superclass method

    # File bundler/vendor/uri/lib/uri/file.rb, line 53
    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 bundler/vendor/uri/lib/uri/file.rb, line 82
    def check_password(user)
      raise Bundler::URI::InvalidURIError, "cannot set password for file Bundler::URI"
    end

check_user(user) click to toggle source

raise `InvalidURIError`

    # File bundler/vendor/uri/lib/uri/file.rb, line 77
    def check_user(user)
      raise Bundler::URI::InvalidURIError, "cannot set user for file Bundler::URI"
    end

check_userinfo(user) click to toggle source

raise `InvalidURIError`

    # File bundler/vendor/uri/lib/uri/file.rb, line 72
    def check_userinfo(user)
      raise Bundler::URI::InvalidURIError, "cannot set userinfo for file Bundler::URI"
    end

set_host(v) click to toggle source

Protected setter for the host component `v`.

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

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

set_password(v) click to toggle source

do nothing

    # File bundler/vendor/uri/lib/uri/file.rb, line 95
    def set_password(v)
    end

set_port(v) click to toggle source

do nothing

    # File bundler/vendor/uri/lib/uri/file.rb, line 68
    def set_port(v)
    end

set_user(v) click to toggle source

do nothing

    # File bundler/vendor/uri/lib/uri/file.rb, line 91
    def set_user(v)
    end

set_userinfo(v) click to toggle source

do nothing

    # File bundler/vendor/uri/lib/uri/file.rb, line 87
    def set_userinfo(v)
    end