Sha256: e8f43099b98bff70bedff9c081cf1b3181b5fc5abb195d25d48317f62ca920e7
Contents?: true
Size: 1.36 KB
Versions: 7
Compression:
Stored size: 1.36 KB
Contents
# frozen_string_literal: true
module RASN1
module Types
# ASN.1 Enumerated
#
# An enumerated type permits to assign names to integer values. It may be defined
# different ways:
# enum = RASN1::Types::Enumerated.new(enum: { 'a' => 0, 'b' => 1, 'c' => 2 })
# enum = RASN1::Types::Enumerated.new(enum: { a: 0, b: 1, c: 2 })
# Its value should be setting as an Integer or a String/symbol:
# enum.value = :b
# enum.value = 1 # equivalent to :b
# But its value is always stored as named integer:
# enum.value = :b
# enum.value # => :b
# enum.value = 0
# enum.value # => :a
# A {EnumeratedError} is raised when set value is not in enumeration.
# @author Sylvain Daubert
class Enumerated < Integer
# @!attribute enum
# @return [Hash]
# Enumerated id value
ID = 0x0a
# @option options [Hash] :enum enumeration hash. Keys are names, and values
# are integers. This key is mandatory.
# @raise [EnumeratedError] +:enum+ key is not present
# @raise [EnumeratedError] +:default+ value is unknown
# @see Base#initialize common options to all ASN.1 types
def initialize(options={})
super
raise EnumeratedError, 'no enumeration given' if @enum.empty?
end
# @return [Hash]
def to_h
@enum
end
end
end
end
Version data entries
7 entries across 7 versions & 1 rubygems