Class: Puppet::FileServing::Content Private

Inherits:
Base show all
Extended by:
Indirector
Defined in:
lib/puppet/file_serving/content.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A class that handles retrieving file contents. It only reads the file when its content is specifically asked for.

API:

  • private

Constant Summary

Constants included from Indirector

Indirector::BadNameRegexp

Instance Attribute Summary collapse

Attributes inherited from Base

#links, #path, #relative_path, #source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Indirector

configure_routes, indirects

Methods inherited from Base

absolute?, #exist?, #full_path, #initialize, #stat, #to_data_hash

Constructor Details

This class inherits a constructor from Puppet::FileServing::Base

Instance Attribute Details

#content ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Read the content of our file in.

API:

  • private



31
32
33
34
35
36
37
38
39
 
# File 'lib/puppet/file_serving/content.rb', line 31

def content
  unless @content
    # This stat can raise an exception, too.
    raise(ArgumentError, _("Cannot read the contents of links unless following links")) if stat.ftype == "symlink"

    @content = Puppet::FileSystem.binread(full_path)
  end
  @content
end

Class Method Details

.from_binary(content) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

API:

  • private



19
20
21
22
23
 
# File 'lib/puppet/file_serving/content.rb', line 19

def self.from_binary(content)
  instance = new("/this/is/a/fake/path")
  instance.content = content
  instance
end

.supported_formats ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

API:

  • private



15
16
17
 
# File 'lib/puppet/file_serving/content.rb', line 15

def self.supported_formats
  [:binary]
end

Instance Method Details

#collect(source_permissions = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This is no longer used, but is still called by the file server implementations when interacting with their model abstraction.

API:

  • private



27
28
 
# File 'lib/puppet/file_serving/content.rb', line 27

def collect(source_permissions = nil)
end

#to_binary ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

API:

  • private



41
42
43
 
# File 'lib/puppet/file_serving/content.rb', line 41

def to_binary
  File.new(full_path, "rb")
end