Method MarshalBinary

structure/zset.go:1164–1201

MarshalBinary serializes the FZSet instance into a byte slice. It uses MessagePack format for serialization Returns the serialized byte slice and an error if the encoding fails.

()

// It uses MessagePack format for serialization
// Returns the serialized byte slice and an error if the encoding fails.
func (fzs *FZSet) MarshalBinary() (_ []byte, err error) {

	// Initializing the MessagePackEncoder
	enc := encoding.NewMessagePackEncoder()

	// Encoding the size attribute of d (i.e., d.size). The operation could fail, thus we check for an error.
	// An error, if occurred, will be returned immediately, hence the flow of execution stops here.
	err = enc.Encode(fzs.size)
	if err != nil {
		return nil, err
	}

	// This is the start of a loop going over all the nodes in d's skip list from the tail of the
	// list to the head.
	// The tail and head pointers refer to the last and first element of the list, respectively,
	// and are maintained for efficient traversing of the list.
	// we do that to get the elements in reverse order from biggest to the smallest for the best
	// insertion efficiency as it makes the insertion O(1), because each new element to be inserted is
	// the smallest yet.
	x := fzs.skipList.tail
	// as long as there are elements in the SkipList continue
	for x != nil {
		// Encoding the value of the current node in the skip list
		// Again, if an error occurs it gets immediately returned, thus breaking the loop.
		err = enc.Encode(x.value)
		if err != nil {
			return nil, err
		}

		// Move to the previous node in the skip list.
		x = x.prev
	}

	// After the traversal of the skip list, the encoder should now hold the serialized representation of the
	// FZSet. Now, we return the bytes from the encoder along with any error that might have occurred
	// during the encoding (should be nil if everything went fine).
	return enc.Bytes(), err
}

// UnmarshalBinary de-serializes the given byte slice into ZSetValue instance
// It uses the MessagePack format for de-serialization