class BSON::Code
Represents a code type, which is a wrapper around javascript code.
@see bsonspec.org/#/specification
@since 2.0.0
Constants
- BSON_TYPE
-
A code is type 0x0D in the
BSON
spec.@since 2.0.0
Attributes
@!attribute javascript
@return [ String ] The javascript code. @since 2.0.0
Public Class Methods
Source
# File lib/bson/code.rb, line 112 def self.from_bson(buffer, **options) new(buffer.get_string) end
Deserialize code from BSON
.
@param [ ByteBuffer
] buffer The byte buffer.
@option options [ nil | :bson ] :mode Decoding mode to use.
@return [ TrueClass
, FalseClass
] The decoded code.
@see bsonspec.org/#/specification
@since 2.0.0
Source
# File lib/bson/code.rb, line 83 def initialize(javascript = "") @javascript = javascript end
Instantiate the new code.
@example Instantiate the new code.
BSON::Code.new("this.value = 5")
@param [ String
] javascript The javascript code.
@since 2.0.0
Public Instance Methods
Source
# File lib/bson/code.rb, line 46 def ==(other) return false unless other.is_a?(Code) javascript == other.javascript end
Determine if this code object is equal to another object.
@example Check the code equality.
code == other
@param [ Object
] other The object to compare against.
@return [ true, false ] If the objects are equal.
@since 2.0.0
Source
# File lib/bson/code.rb, line 71 def as_extended_json(**options) { "$code" => javascript } end
Converts this object to a representation directly serializable to Extended JSON
(github.com/mongodb/specifications/blob/master/source/extended-json.rst).
@option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
(default is canonical extended JSON)
@return [ Hash
] The extended json representation.
Source
# File lib/bson/code.rb, line 60 def as_json(*args) as_extended_json end
Get the code as JSON
hash data.
@example Get the code as a JSON
hash.
code.as_json
@return [ Hash
] The code as a JSON
hash.
@since 2.0.0 @deprecated Use as_extended_json
instead.
Source
# File lib/bson/code.rb, line 97 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_string(javascript) # @todo: was formerly to_bson_string end
Encode the javascript code.
@example Encode the code.
code.to_bson
@return [ BSON::ByteBuffer
] The buffer with the encoded object.
@see bsonspec.org/#/specification
@since 2.0.0