class Vagrant::Plugin::Remote::SyncedFolder

Attributes

client[RW]

Add an attribute accesor for the client when applied to the SyncedFolder class

Public Class Methods

new(client: nil) click to toggle source

# File lib/vagrant/plugin/remote/synced_folder.rb, line 12
def initialize(client: nil)
  if client.nil?
    raise ArgumentError,
      "Remote client is required for `#{self.class.name}`"
  end
  @client = client
  @logger = Log4r::Logger.new("vagrant::remote::synced_folder::#{self.class.name}")
  if client.nil?
    @logger.warn("synced folder remote client is unset")
  end
end

Public Instance Methods

_initialize(machine, synced_folder_type, client=nil) click to toggle source

# File lib/vagrant/plugin/remote/synced_folder.rb, line 24
def _initialize(machine, synced_folder_type, client=nil)
  if client.nil? && Manager.client
    @client = Manager.client.get_plugin(
      name: synced_folder_type,
      type: :synced_folder,
    )
  else
    raise "Cannot set remote client for synced folder, no manager available"
  end

  self
end

capability(cap_name, *args) click to toggle source

Executes the capability with the given name, optionally passing more arguments onwards to the capability. If the capability returns a value, it will be returned.

@param [Symbol] cap_name Name of the capability

# File lib/vagrant/plugin/remote/synced_folder.rb, line 87
def capability(cap_name, *args)
  @logger.debug("running remote synced folder capability #{cap_name} with args #{args}")
  client.capability(cap_name, *args)
end

capability?(cap_name) click to toggle source

Tests whether the given capability is possible.

@param [Symbol] cap_name Capability name @return [Boolean]

# File lib/vagrant/plugin/remote/synced_folder.rb, line 96
def capability?(cap_name)
  @logger.debug("checking for remote synced folder capability #{cap_name}")
  client.has_capability?(cap_name)
end

cleanup(machine, opts) click to toggle source

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

# File lib/vagrant/plugin/remote/synced_folder.rb, line 78
def cleanup(machine, opts)
  client.cleanup(machine, opts)
end

disable(machine, folders, opts) click to toggle source

@param [Machine] machine The machine to modify. @param [Hash] folders The folders to remove. This will not contain

any folders that should remain.

@param [Hash] opts Any options for the synced folders.

# File lib/vagrant/plugin/remote/synced_folder.rb, line 72
def disable(machine, folders, opts)
  client.disable(machine, folders, opts)
end

enable(machine, folders, opts) click to toggle source

@param [Machine] machine @param [Hash] folders Folders to remove @param [Hash] opts Any options for the synced folders.

# File lib/vagrant/plugin/remote/synced_folder.rb, line 64
def enable(machine, folders, opts)
  client.enable(machine, folders, opts)
end

initialize_capabilities!(host, hosts, capabilities, *args) click to toggle source

# File lib/vagrant/plugin/remote/synced_folder.rb, line 37
def initialize_capabilities!(host, hosts, capabilities, *args)
  # no-op
end

prepare(machine, folders, opts) click to toggle source

@param [Machine] machine @param [Hash] folders The folders to remove. This will not contain

any folders that should remain.

@param [Hash] opts Any options for the synced folders.

# File lib/vagrant/plugin/remote/synced_folder.rb, line 45
def prepare(machine, folders, opts)
  client.prepare(machine, folders, opts)
end

to_proto() click to toggle source

# File lib/vagrant/plugin/remote/synced_folder.rb, line 101
def to_proto
  client.proto
end

usable?(machine, raise_error=false) click to toggle source

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

if it isn't usable.

@return [Boolean]

# File lib/vagrant/plugin/remote/synced_folder.rb, line 53
def usable?(machine, raise_error=false)
  begin
    client.usable(machine)
  rescue
    raise if raise_error
  end
end