class Vagrant::Plugin::V2::SyncedFolder

This is the base class for a synced folder implementation.

Public Instance Methods

cleanup(machine, opts) click to toggle source

This is called after destroying the machine during a `vagrant destroy` and also prior to syncing folders during a `vagrant up`.

No return value.

@param [Machine] machine @param [Hash] opts

# File lib/vagrant/plugin/v2/synced_folder.rb, line 40
def cleanup(machine, opts)
end
enable(machine, folders, opts) click to toggle source

This is called after the machine is booted and after networks are setup.

No return value.

# File lib/vagrant/plugin/v2/synced_folder.rb, line 29
def enable(machine, folders, opts)
end
prepare(machine, folders, opts) click to toggle source

This is called before the machine is booted, allowing the implementation to make any machine modifications or perhaps verifications.

No return value.

# File lib/vagrant/plugin/v2/synced_folder.rb, line 22
def prepare(machine, folders, opts)
end
usable?(machine, raise_error=false) click to toggle source

This is called early when the synced folder is set to determine if this implementation can be used for this machine. This should return true or false.

@param [Machine] machine @param [Boolean] raise_error If true, should raise an exception

if it isn't usable.

@return [Boolean]

# File lib/vagrant/plugin/v2/synced_folder.rb, line 14
def usable?(machine, raise_error=false)
end