module BSON::String
Injects behaviour for encoding and decoding string values to and from raw bytes as specified by the BSON spec.
@see bsonspec.org/#/specification
@since 2.0.0
Constants
- BSON_TYPE
A string is type 0x02 in the BSON spec.
@since 2.0.0
Public Instance Methods
Get the string as encoded BSON.
@example Get the string as encoded BSON.
"test".to_bson
@raise [ EncodingError ] If the string is not UTF-8.
@return [ String ] The encoded string.
@see bsonspec.org/#/specification
@since 2.0.0
# File lib/bson/string.rb, line 42 def to_bson(buffer = ByteBuffer.new) buffer.put_string(self) end
Get the string as a BSON key name encoded C string with checking for special characters.
@example Get the string as key name.
"test".to_bson_key
@raise [ EncodingError ] If the string is not UTF-8.
@return [ String ] The encoded string.
@see bsonspec.org/#/specification
@since 2.0.0
# File lib/bson/string.rb, line 58 def to_bson_key self end
Convert the string to an object id. This will only work for strings of size 12.
@example Convert the string to an object id.
string.to_bson_object_id
@note This is used for repairing legacy bson data.
@raise [ InvalidObjectId ] If the string is not 12 elements.
@return [ String ] The raw object id bytes.
@since 2.0.0
# File lib/bson/string.rb, line 75 def to_bson_object_id ObjectId.repair(self) end
Convert the string to a hexidecimal representation.
@example Convert the string to hex.
"\x01".to_hex_string
@return [ String ] The string as hex.
@since 2.0.0
# File lib/bson/string.rb, line 87 def to_hex_string unpack("H*")[0] end