Parent

BSON::Undefined

Represents the Undefined BSON type

@see bsonspec.org/#/specification

@since 2.0.0

Constants

BSON_TYPE

Undefined is type 0x06 in the BSON spec.

@since 2.0.0

Public Class Methods

from_bson(bson) click to toggle source

Deserialize undefined BSON type from BSON.

@param [ BSON ] bson The encoded undefined value.

@return [ Undefined ] The decoded undefined value.

@see bsonspec.org/#/specification

@since 2.0.0

# File lib/bson/undefined.rb, line 65
def self.from_bson(bson)
  new
end

Public Instance Methods

==(other) click to toggle source

Determine if undefined is equal to another object.

@example Check undefined equality.

BSON::Undefined.new == object

@param [ Object ] other The object to check against.

@return [ true, false ] If the objects are equal.

@since 2.0.0

# File lib/bson/undefined.rb, line 39
def ==(other)
  self.class == other.class
end
to_bson(encoded = ''.force_encoding(BINARY)) click to toggle source

Encode the Undefined field - has no value since it only needs the type and field name when being encoded.

@example Encode the undefined value.

Undefined.to_bson

@return [ String ] An empty string.

@since 2.0.0

# File lib/bson/undefined.rb, line 52
def to_bson(encoded = ''.force_encoding(BINARY))
  encoded
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.