Class: FhirPackagesManager::FetchResult

Inherits:
Struct
  • Object
show all
Defined in:
lib/fhir_packages_manager/fetch_result.rb

Overview

Outcome of Manager#fetch (or Manager#sync) for a single package/version.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#error ⇒ String?

Returns the error message, when status is :error.

Returns:

  • (String, nil) —

    the error message, when status is :error



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 16

class FetchResult < Struct.new(:package, :status, :registry, :path, :error, keyword_init: true)
  # @return [Boolean] true if the package was downloaded successfully
  def downloaded?
    status == :downloaded
  end

  # @return [Boolean] true if the package was skipped because it's on the ignore list
  def ignored?
    status == :ignored
  end

  # @return [Boolean] true if {Manager#sync} skipped it because it was already downloaded
  def skipped?
    status == :skipped
  end

  # @return [Boolean] true if no registry had the package/version
  def not_found?
    status == :not_found
  end

  # @return [Boolean] true if downloading raised an HTTP error
  def error?
    status == :error
  end
end

#package ⇒ Package

Returns the package that was requested (version resolved, when downloaded).

Returns:

  • (Package) —

    the package that was requested (version resolved, when downloaded)



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 16

class FetchResult < Struct.new(:package, :status, :registry, :path, :error, keyword_init: true)
  # @return [Boolean] true if the package was downloaded successfully
  def downloaded?
    status == :downloaded
  end

  # @return [Boolean] true if the package was skipped because it's on the ignore list
  def ignored?
    status == :ignored
  end

  # @return [Boolean] true if {Manager#sync} skipped it because it was already downloaded
  def skipped?
    status == :skipped
  end

  # @return [Boolean] true if no registry had the package/version
  def not_found?
    status == :not_found
  end

  # @return [Boolean] true if downloading raised an HTTP error
  def error?
    status == :error
  end
end

#path ⇒ String?

Returns where the tarball was (or already is) on disk, if downloaded/skipped.

Returns:

  • (String, nil) —

    where the tarball was (or already is) on disk, if downloaded/skipped



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 16

class FetchResult < Struct.new(:package, :status, :registry, :path, :error, keyword_init: true)
  # @return [Boolean] true if the package was downloaded successfully
  def downloaded?
    status == :downloaded
  end

  # @return [Boolean] true if the package was skipped because it's on the ignore list
  def ignored?
    status == :ignored
  end

  # @return [Boolean] true if {Manager#sync} skipped it because it was already downloaded
  def skipped?
    status == :skipped
  end

  # @return [Boolean] true if no registry had the package/version
  def not_found?
    status == :not_found
  end

  # @return [Boolean] true if downloading raised an HTTP error
  def error?
    status == :error
  end
end

#registry ⇒ String?

Returns the base URL of the registry that served the package, if downloaded.

Returns:

  • (String, nil) —

    the base URL of the registry that served the package, if downloaded



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 16

class FetchResult < Struct.new(:package, :status, :registry, :path, :error, keyword_init: true)
  # @return [Boolean] true if the package was downloaded successfully
  def downloaded?
    status == :downloaded
  end

  # @return [Boolean] true if the package was skipped because it's on the ignore list
  def ignored?
    status == :ignored
  end

  # @return [Boolean] true if {Manager#sync} skipped it because it was already downloaded
  def skipped?
    status == :skipped
  end

  # @return [Boolean] true if no registry had the package/version
  def not_found?
    status == :not_found
  end

  # @return [Boolean] true if downloading raised an HTTP error
  def error?
    status == :error
  end
end

#status ⇒ Symbol

Returns one of :downloaded, :ignored, :skipped, :not_found, :error.

Returns:

  • (Symbol) —

    one of :downloaded, :ignored, :skipped, :not_found, :error



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 16

class FetchResult < Struct.new(:package, :status, :registry, :path, :error, keyword_init: true)
  # @return [Boolean] true if the package was downloaded successfully
  def downloaded?
    status == :downloaded
  end

  # @return [Boolean] true if the package was skipped because it's on the ignore list
  def ignored?
    status == :ignored
  end

  # @return [Boolean] true if {Manager#sync} skipped it because it was already downloaded
  def skipped?
    status == :skipped
  end

  # @return [Boolean] true if no registry had the package/version
  def not_found?
    status == :not_found
  end

  # @return [Boolean] true if downloading raised an HTTP error
  def error?
    status == :error
  end
end

Instance Method Details

#downloaded? ⇒ Boolean

Returns true if the package was downloaded successfully.

Returns:

  • (Boolean) —

    true if the package was downloaded successfully



18
19
20
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 18

def downloaded?
  status == :downloaded
end

#error? ⇒ Boolean

Returns true if downloading raised an HTTP error.

Returns:

  • (Boolean) —

    true if downloading raised an HTTP error



38
39
40
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 38

def error?
  status == :error
end

#ignored? ⇒ Boolean

Returns true if the package was skipped because it's on the ignore list.

Returns:

  • (Boolean) —

    true if the package was skipped because it's on the ignore list



23
24
25
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 23

def ignored?
  status == :ignored
end

#not_found? ⇒ Boolean

Returns true if no registry had the package/version.

Returns:

  • (Boolean) —

    true if no registry had the package/version



33
34
35
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 33

def not_found?
  status == :not_found
end

#skipped? ⇒ Boolean

Returns true if Manager#sync skipped it because it was already downloaded.

Returns:

  • (Boolean) —

    true if Manager#sync skipped it because it was already downloaded



28
29
30
 
# File 'lib/fhir_packages_manager/fetch_result.rb', line 28

def skipped?
  status == :skipped
end