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
Deserialize code from BSON
.
@param [ ByteBuffer
] buffer The byte buffer.
@return [ TrueClass
, FalseClass
] The decoded code.
@see bsonspec.org/#/specification
@since 2.0.0
# File lib/bson/code.rb, line 97 def self.from_bson(buffer) new(buffer.get_string) 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
# File lib/bson/code.rb, line 70 def initialize(javascript = "") @javascript = javascript end
Public Instance Methods
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
# File lib/bson/code.rb, line 45 def ==(other) return false unless other.is_a?(Code) javascript == other.javascript 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
# File lib/bson/code.rb, line 84 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_string(javascript) # @todo: was formerly to_bson_string end