Namespace

Included Modules

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

from_bson_string() click to toggle source

Take the binary string and return a UTF-8 encoded string.

@example Convert from a BSON string.

"\x00".from_bson_string

@raise [ EncodingError ] If the string is not UTF-8.

@return [ String ] The UTF-8 string.

@since 2.0.0

# File lib/bson/string.rb, line 142
def from_bson_string
  force_encoding(UTF8)
end
set_int32(pos, int32) click to toggle source

Set four bytes for int32 in a binary string and return it.

@example Set int32 in a BSON string.

"".set_int32(pos, int32)

@param [ Fixnum ] The position to set. @param [ Fixnum ] The int32 value.

@return [ String ] The binary string.

@since 2.0.0

# File lib/bson/string.rb, line 157
def set_int32(pos, int32)
  self[pos, 4] = [ int32 ].pack(Int32::PACK)
end
to_bson(encoded = ''.force_encoding(BINARY)) click to toggle source

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 43
def to_bson(encoded = ''.force_encoding(BINARY))
  encode_with_placeholder_and_null(STRING_ADJUST, encoded) do |encoded|
    to_bson_string(encoded)
  end
end
to_bson_cstring(encoded = ''.force_encoding(BINARY)) click to toggle source

Get the string as an encoded C string.

@example Get the string as an encoded C string.

"test".to_bson_cstring

@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 77
def to_bson_cstring(encoded = ''.force_encoding(BINARY))
  check_for_illegal_characters!
  to_bson_string(encoded) << NULL_BYTE
end
to_bson_key(encoded = ''.force_encoding(BINARY)) click to toggle source

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 61
def to_bson_key(encoded = ''.force_encoding(BINARY))
  to_bson_cstring(encoded)
end
to_bson_object_id() click to toggle source

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 95
def to_bson_object_id
  ObjectId.repair(self)
end
to_bson_string(encoded = ''.force_encoding(BINARY)) click to toggle source

Convert the string to a UTF-8 string then force to binary. This is so we get errors for strings that are not UTF-8 encoded.

@example Convert to valid BSON string.

"Straße".to_bson_string

@raise [ EncodingError ] If the string is not UTF-8.

@return [ String ] The binary string.

@since 2.0.0

# File lib/bson/string.rb, line 110
def to_bson_string(encoded = ''.force_encoding(BINARY))
  begin
    to_utf8_binary(encoded)
  rescue EncodingError
    data = dup.force_encoding(UTF8)
    raise unless data.valid_encoding?
    encoded << data.force_encoding(BINARY)
  end
end
to_hex_string() click to toggle source

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 128
def to_hex_string
  unpack("H*")[0]
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.