Module: Puppet::Network::FormatSupport

Included in:
ModuleTool::Checksums, ModuleTool::Dependency, ModuleTool::Metadata, Relationship, Resource::Status, Transaction::Event, Util::Log, Util::Metric, Util::TagSet
Defined in:
lib/puppet/network/format_support.rb

Overview

Provides network serialization support when included

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



6
7
8
 
# File 'lib/puppet/network/format_support.rb', line 6

def self.included(klass)
  klass.extend(ClassMethods)
end

Instance Method Details

#mime(format = nil) ⇒ Object 



112
113
114
115
116
117
118
119
 
# File 'lib/puppet/network/format_support.rb', line 112

def mime(format = nil)
  format ||= self.class.default_format

  self.class.get_format(format).mime
rescue => err
  #TRANSLATORS "mime" is a function name and should not be translated
  raise Puppet::Network::FormatHandler::FormatError, _("Could not mime to %{format}: %{err}") % { format: format, err: err }, err.backtrace
end

#render(format = nil) ⇒ Object 



103
104
105
106
107
108
109
110
 
# File 'lib/puppet/network/format_support.rb', line 103

def render(format = nil)
  format ||= self.class.default_format

  self.class.get_format(format).render(self)
rescue => err
  #TRANSLATORS "render" is a function name and should not be translated
  raise Puppet::Network::FormatHandler::FormatError, _("Could not render to %{format}: %{err}") % { format: format, err: err }, err.backtrace
end

#support_format?(name) ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/puppet/network/format_support.rb', line 121

def support_format?(name)
  self.class.support_format?(name)
end

#to_data_hash(*args) ⇒ Hash

This method is abstract.

This method may be implemented to return a hash object that is used for serializing. The object returned by this method should contain all the info needed to instantiate it again. If the method exists it will be called from to_msgpack and other serialization methods.

Returns:




# File 'lib/puppet/network/format_support.rb', line 125

#to_json(*args) ⇒ Object 



99
100
101
 
# File 'lib/puppet/network/format_support.rb', line 99

def to_json(*args)
  to_data_hash.to_json(*args)
end

#to_msgpack(*args) ⇒ Object 



90
91
92
 
# File 'lib/puppet/network/format_support.rb', line 90

def to_msgpack(*args)
  to_data_hash.to_msgpack(*args)
end

#to_pson(*args) ⇒ Object

@deprecated, use to_json



95
96
97
 
# File 'lib/puppet/network/format_support.rb', line 95

def to_pson(*args)
  to_data_hash.to_pson(*args)
end