Module: FIRM::Serializable::SerializeInstanceMethods
- Defined in:
- lib/firm/serializable.rb,
lib/firm/serializer/xml.rb,
lib/firm/serializer/json.rb,
lib/firm/serializer/yaml.rb
Overview
extend instance serialization methods
Instance Method Summary collapse
-
#disable_serialize ⇒ void
Disables serialization for this object as a single property or as part of a property container (array or set).
- #encode_with(coder) ⇒ Object
- #init_with(coder) ⇒ Object
-
#serialize(io = nil, pretty: false, format: Serializable.default_format) ⇒ Object
Serialize this object.
-
#serialize_disabled? ⇒ true, false
Returns true if regular serialization for this object has been disabled, false otherwise (default).
Methods included from JSON::SerializeInstanceMethods
Methods included from XML::SerializeInstanceMethods
Instance Method Details
#disable_serialize ⇒ void
This method returns an undefined value.
Disables serialization for this object as a single property or as part of a property container (array or set).
496 497 498 499 |
# File 'lib/firm/serializable.rb', line 496 def disable_serialize # by default unset (nil) so serializing enabled @serialize_disabled = true end |
#encode_with(coder) ⇒ Object
114 115 116 |
# File 'lib/firm/serializer/yaml.rb', line 114 def encode_with(coder) for_serialize(coder) end |
#init_with(coder) ⇒ Object
118 119 120 121 |
# File 'lib/firm/serializer/yaml.rb', line 118 def init_with(coder) from_serialized(coder.map) finalize_from_serialized end |
#serialize(pretty: false, format: Serializable.default_format) ⇒ String #serialize(io, pretty: false, format: Serializable.default_format) ⇒ IO
Serialize this object
481 482 483 |
# File 'lib/firm/serializable.rb', line 481 def serialize(io = nil, pretty: false, format: Serializable.default_format) Serializable[format].dump(self, io, pretty: pretty) end |
#serialize_disabled? ⇒ true, false
Returns true if regular serialization for this object has been disabled, false otherwise (default). Disabled serialization can be overridden for single objects (not objects maintained in property containers like arrays and sets).
489 490 491 |
# File 'lib/firm/serializable.rb', line 489 def serialize_disabled? !!@serialize_disabled # true for any value but false end |