Class: AWSCDK::FileSystem

Inherits:
Jsii::Object
  • Object
show all
Defined in:
file_system.rb

Overview

File system utilities.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FileSystem

Returns a new instance of FileSystem.



8
9
10
 
# File 'file_system.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.copy_directory(src_dir, dest_dir, options = nil, root_dir = nil) ⇒ void

This method returns an undefined value.

Copies an entire directory structure.

Parameters:

  • src_dir (String) —

    Source directory.

  • dest_dir (String) —

    Destination directory.

  • options (AWSCDK::CopyOptions, nil) (defaults to: nil) —

    options.

  • root_dir (String, nil) (defaults to: nil) —

    Root directory to calculate exclusions from.



24
25
26
27
28
29
30
31
 
# File 'file_system.rb', line 24

def self.copy_directory(src_dir, dest_dir, options = nil, root_dir = nil)
  Jsii::Type.check_type(src_dir, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "srcDir")
  Jsii::Type.check_type(dest_dir, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destDir")
  options = options.is_a?(Hash) ? ::AWSCDK::CopyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Db3B5T3B0aW9ucyJ9")), "options") unless options.nil?
  Jsii::Type.check_type(root_dir, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "rootDir") unless root_dir.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.FileSystem", "copyDirectory", [src_dir, dest_dir, options, root_dir])
end

.fingerprint(file_or_directory, options = nil) ⇒ String

Produces fingerprint based on the contents of a single file or an entire directory tree.

Line endings are converted from CRLF to LF.

The fingerprint will also include:

  1. An extra string if defined in options.extra.
  2. The symlink follow mode value.

Parameters:

  • file_or_directory (String) —

    The directory or file to fingerprint.

  • options (AWSCDK::FingerprintOptions, nil) (defaults to: nil) —

    Fingerprinting options.

Returns:

  • (String) 


45
46
47
48
49
50
 
# File 'file_system.rb', line 45

def self.fingerprint(file_or_directory, options = nil)
  Jsii::Type.check_type(file_or_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileOrDirectory")
  options = options.is_a?(Hash) ? ::AWSCDK::FingerprintOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5GaW5nZXJwcmludE9wdGlvbnMifQ==")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.FileSystem", "fingerprint", [file_or_directory, options])
end

.is_empty(dir) ⇒ Boolean

Checks whether a directory is empty.

Parameters:

  • dir (String) —

    The directory to check.

Returns:

  • (Boolean) 


56
57
58
59
 
# File 'file_system.rb', line 56

def self.is_empty(dir)
  Jsii::Type.check_type(dir, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dir")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.FileSystem", "isEmpty", [dir])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
 
# File 'file_system.rb', line 12

def self.jsii_overridable_methods
  {
  }
end

.mkdtemp(prefix) ⇒ String

Creates a unique temporary directory in the system temp directory.

Parameters:

  • prefix (String) —

    A prefix for the directory name.

Returns:

  • (String) 


65
66
67
68
 
# File 'file_system.rb', line 65

def self.mkdtemp(prefix)
  Jsii::Type.check_type(prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.FileSystem", "mkdtemp", [prefix])
end

.rmrf(dirname) ⇒ void

This method returns an undefined value.

Deletes a directory.

Parameters:

  • dirname (String) 


74
75
76
77
 
# File 'file_system.rb', line 74

def self.rmrf(dirname)
  Jsii::Type.check_type(dirname, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dirname")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.FileSystem", "rmrf", [dirname])
end

.tmpdir ⇒ String

The real path of the system temp directory.

Returns:

  • (String) 


82
83
84
 
# File 'file_system.rb', line 82

def self.tmpdir()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.FileSystem", "tmpdir")
end