Class: Vagrant::Downloaders::Base

Inherits:

Object

• Object
• Vagrant::Downloaders::Base

Includes:

Util

Defined in:

lib/vagrant/downloaders/base.rb

Overview

Represents a base class for a downloader. A downloader handles downloading a box file to a temporary file.

Direct Known Subclasses

File, HTTP

Instance Attribute Summary

• #env ⇒ Object readonly

  The environment which this downloader is operating.

Instance Method Summary

• #download!(source_url, destination_file) ⇒ Object

  Downloads the source file to the destination file.

• #initialize(env) ⇒ Base constructor

  A new instance of Base.

• #prepare(source_url) ⇒ Object

  Called prior to execution so any error checks can be done.

Constructor Details

#initialize(env) ⇒ Base

Returns a new instance of Base.

# File 'lib/vagrant/downloaders/base.rb', line 11

def initialize(env)
  @env = env
end

Instance Attribute Details

#env ⇒ Object (readonly)

The environment which this downloader is operating.

# File 'lib/vagrant/downloaders/base.rb', line 9

def env
  @env
end

Instance Method Details

#download!(source_url, destination_file) ⇒ Object

Downloads the source file to the destination file. It is up to implementors of this class to handle the logic.

# File 'lib/vagrant/downloaders/base.rb', line 20

def download!(source_url, destination_file); end

#prepare(source_url) ⇒ Object

Called prior to execution so any error checks can be done

# File 'lib/vagrant/downloaders/base.rb', line 16

def prepare(source_url); end