Class: BSON::Code
Overview
Represents a code type, which is a wrapper around javascript code.
Constant Summary collapse
- BSON_TYPE =
A code is type 0x0D in the BSON spec.
13.chr.force_encoding(BINARY).freeze
Instance Attribute Summary collapse
Class Method Summary collapse
-
.from_bson(buffer, **options) ⇒ TrueClass, FalseClass
Deserialize code from BSON.
Instance Method Summary collapse
-
#==(other) ⇒ true, false
Determine if this code object is equal to another object.
-
#as_extended_json(**options) ⇒ Hash
Converts this object to a representation directly serializable to Extended JSON (github.com/mongodb/specifications/blob/master/source/extended-json.rst).
-
#as_json(*args) ⇒ Hash
deprecated
Deprecated.
Use as_extended_json instead.
-
#initialize(javascript = "") ⇒ Code
constructor
Instantiate the new code.
-
#to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) ⇒ BSON::ByteBuffer
Encode the javascript code.
Methods included from JSON
Constructor Details
#initialize(javascript = "") ⇒ Code
Instantiate the new code.
82 83 84 |
# File 'lib/bson/code.rb', line 82 def initialize(javascript = "") @javascript = javascript end |
Instance Attribute Details
Class Method Details
.from_bson(buffer, **options) ⇒ TrueClass, FalseClass
Deserialize code from BSON.
111 112 113 |
# File 'lib/bson/code.rb', line 111 def self.from_bson(buffer, **) new(buffer.get_string) end |
Instance Method Details
#==(other) ⇒ true, false
Determine if this code object is equal to another object.
45 46 47 48 |
# File 'lib/bson/code.rb', line 45 def ==(other) return false unless other.is_a?(Code) javascript == other.javascript end |
#as_extended_json(**options) ⇒ Hash
Converts this object to a representation directly serializable to Extended JSON (github.com/mongodb/specifications/blob/master/source/extended-json.rst).
70 71 72 |
# File 'lib/bson/code.rb', line 70 def as_extended_json(**) { "$code" => javascript } end |
#as_json(*args) ⇒ Hash
Use as_extended_json instead.
Get the code as JSON hash data.
59 60 61 |
# File 'lib/bson/code.rb', line 59 def as_json(*args) as_extended_json end |
#to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) ⇒ BSON::ByteBuffer
Encode the javascript code.
96 97 98 |
# File 'lib/bson/code.rb', line 96 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_string(javascript) # @todo: was formerly to_bson_string end |