Class: ConfigBuilder::Model::SyncedFolder

Inherits:
Base
  • Object
show all
Defined in:
lib/config_builder/model/synced_folder.rb

Overview

Vagrant shared folder model.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#attr, #attrs=, #call, #configure!, def_model_attribute, def_model_delegator, def_model_id, def_model_option, #eval_models, #instance_id, #instance_options, model_attributes, model_delegators, #model_delegators, model_options, new_from_hash, #with_attr

Instance Attribute Details

#create ⇒ Boolean

Returns If true, the host path will be created if it does not exist.

Returns:

  • (Boolean) —

    If true, the host path will be created if it does not exist.



17
 
# File 'lib/config_builder/model/synced_folder.rb', line 17

def_model_attribute :create

#disabled ⇒ Boolean

Returns If the mount point should be disabled.

Returns:

  • (Boolean) —

    If the mount point should be disabled.



26
 
# File 'lib/config_builder/model/synced_folder.rb', line 26

def_model_attribute :disabled

#group ⇒ String

Returns The group that will own the synced folder. By default this will be the SSH user.

Returns:

  • (String) —

    The group that will own the synced folder. By default this will be the SSH user.



31
 
# File 'lib/config_builder/model/synced_folder.rb', line 31

def_model_attribute :group

#guest_path ⇒ String

Returns The guest file path to be used as the mount point.

Returns:

  • (String) —

    The guest file path to be used as the mount point.



12
 
# File 'lib/config_builder/model/synced_folder.rb', line 12

def_model_attribute :guest_path

#host_path ⇒ String

Returns The host file path to mount on the guest.

Returns:

  • (String) —

    The host file path to mount on the guest.



8
 
# File 'lib/config_builder/model/synced_folder.rb', line 8

def_model_attribute :host_path

#mount_options ⇒ Array<String>

Returns A list of additional options to pass to the mount. command.

Returns:

  • (Array<String>) —

    A list of additional options to pass to the mount. command.



22
 
# File 'lib/config_builder/model/synced_folder.rb', line 22

def_model_attribute :mount_options

#nfs_export ⇒ nfs_udp

Returns Whether or not to use UDP as the transport.

Returns:

  • (nfs_udp) —

    Whether or not to use UDP as the transport.



44
 
# File 'lib/config_builder/model/synced_folder.rb', line 44

def_model_attribute :nfs_export

#nfs_version ⇒ Fixnum, String

Returns The NFS protocol version to use.

Returns:

  • (Fixnum, String) —

    The NFS protocol version to use.



52
 
# File 'lib/config_builder/model/synced_folder.rb', line 52

def_model_attribute :nfs_version

#owner ⇒ String

Returns The user who should be the owner of this synced folder. By default this will be the SSH user.

Returns:

  • (String) —

    The user who should be the owner of this synced folder. By default this will be the SSH user.



36
 
# File 'lib/config_builder/model/synced_folder.rb', line 36

def_model_attribute :owner

#rsync__args ⇒ Array<String>

Returns A list of arguments to supply to rsync.

Returns:

  • (Array<String>) —

    A list of arguments to supply to rsync.



56
 
# File 'lib/config_builder/model/synced_folder.rb', line 56

def_model_attribute :rsync__args

#rsync__auto ⇒ Boolean

Returns If false, then rsync-auto will not watch and.

Returns:

  • (Boolean) —

    If false, then rsync-auto will not watch and




# File 'lib/config_builder/model/synced_folder.rb', line 58

#rsync__chown ⇒ Boolean

Returns If false, then the owner and group options for the synced folder are ignored and Vagrant will not execute a recursive chown.

Returns:

  • (Boolean) —

    If false, then the owner and group options for the synced folder are ignored and Vagrant will not execute a recursive chown.



66
 
# File 'lib/config_builder/model/synced_folder.rb', line 66

def_model_attribute :rsync__chown

#rsync__exclude ⇒ String+

Returns A list of files or directories to exclude from the sync.

Returns:

  • (String, Array<String>) —

    A list of files or directories to exclude from the sync.



71
 
# File 'lib/config_builder/model/synced_folder.rb', line 71

def_model_attribute :rsync__exclude

#rsync__rsync_path ⇒ String

Returns The path on the remote host where rsync is and how it is.

Returns:

  • (String) —

    The path on the remote host where rsync is and how it is




# File 'lib/config_builder/model/synced_folder.rb', line 73

#rsync__verbose ⇒ Boolean

Returns If true, then the output from the rsync process will be echoed to the console.

Returns:

  • (Boolean) —

    If true, then the output from the rsync process will be echoed to the console.



81
 
# File 'lib/config_builder/model/synced_folder.rb', line 81

def_model_attribute :rsync__verbose

#type ⇒ String

Returns The method for syncing folder to guest.

Returns:

  • (String) —

    The method for syncing folder to guest.



40
 
# File 'lib/config_builder/model/synced_folder.rb', line 40

def_model_attribute :type

Instance Method Details

#to_proc ⇒ Object 



83
84
85
86
87
 
# File 'lib/config_builder/model/synced_folder.rb', line 83

def to_proc
  Proc.new do |vm_config|
    vm_config.synced_folder(attr(:host_path), attr(:guest_path), folder_opts)
  end
end