Parent

Included Modules

Class Index [+]

Quicksearch

Net::SSH::Version

A class for describing the current version of a library. The version consists of three parts: the major number, the minor number, and the tiny (or patch) number.

Two Version instances may be compared, so that you can test that a version of a library is what you require:

  require 'net/ssh/version'

  if Net::SSH::Version::CURRENT < Net::SSH::Version[2,1,0]
    abort "your software is too old!"
  end

Constants

MAJOR

The major component of this version of the Net::SSH library

MINOR

The minor component of this version of the Net::SSH library

TINY

The tiny component of this version of the Net::SSH library

CURRENT

The current version of the Net::SSH library as a Version instance

STRING

The current version of the Net::SSH library as a String

Attributes

major[R]
minor[R]
tiny[R]

Public Class Methods

[](major, minor, tiny) click to toggle source

A convenience method for instantiating a new Version instance with the given major, minor, and tiny components.

    # File lib/net/ssh/version.rb, line 19
19:     def self.[](major, minor, tiny)
20:       new(major, minor, tiny)
21:     end
new(major, minor, tiny) click to toggle source

Create a new Version object with the given components.

    # File lib/net/ssh/version.rb, line 26
26:     def initialize(major, minor, tiny)
27:       @major, @minor, @tiny = major, minor, tiny
28:     end

Public Instance Methods

<=>(version) click to toggle source

Compare this version to the given version object.

    # File lib/net/ssh/version.rb, line 31
31:     def <=>(version)
32:       to_i <=> version.to_i
33:     end
to_i() click to toggle source

Converts this version to a canonical integer that may be compared against other version objects.

    # File lib/net/ssh/version.rb, line 43
43:     def to_i
44:       @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
45:     end
to_s() click to toggle source

Converts this version object to a string, where each of the three version components are joined by the ’.’ character. E.g., 2.0.0.

    # File lib/net/ssh/version.rb, line 37
37:     def to_s
38:       @to_s ||= [@major, @minor, @tiny].join(".")
39:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.