File: timestamp.rb

package info (click to toggle)
ruby-bson 1.10.0-1%2Bdeb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 284 kB
  • ctags: 269
  • sloc: ruby: 1,551; makefile: 5
file content (72 lines) | stat: -rw-r--r-- 1,998 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# Copyright (C) 2009-2013 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

module BSON

  # A class for representing BSON Timestamps. The Timestamp type is used
  # by MongoDB internally; thus, it should be used by application developers
  # for diagnostic purposes only.
  class Timestamp
    include Enumerable

    attr_reader :seconds, :increment

    # Create a new BSON Timestamp.
    #
    # @param [Integer] seconds The number of seconds
    # @param increment
    def initialize(seconds, increment)
      @seconds   = seconds
      @increment = increment
    end

    def to_s
      "seconds: #{seconds}, increment: #{increment}"
    end

    def ==(other)
      self.seconds == other.seconds &&
        self.increment == other.increment
    end

    # This is for backward-compatibility. Timestamps in the Ruby
    # driver used to deserialize as arrays. So we provide
    # an equivalent interface.
    #
    # @deprecated
    def [](index)
      warn "Timestamps are no longer deserialized as arrays. If you're working " +
        "with BSON Timestamp objects, see the BSON::Timestamp class. This usage will " +
        "be deprecated in Ruby Driver v2.0."
      if index == 0
        self.increment
      elsif index == 1
        self.seconds
      else
        nil
      end
    end

    # This method exists only for backward-compatibility.
    #
    # @deprecated
    def each
      i = 0
      while i < 2
        yield self[i]
        i += 1
      end
    end
  end
end