bin_struct 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e365efdb982166cda39456fd9b1afb6c9a241aae1ed64df6a3121c0f67cee2
-  data.tar.gz: bb98e9835da23a370375d5879e6210015dbae8d9a0cf1676aee22fac2ab804fb
+  metadata.gz: d31367b8cbffd8fd978aab672f493f0d2e1fc099daf19a4cc596ff54f862c43a
+  data.tar.gz: dbd457e23e12953f89576c4dc2790b56486d0da3c37dbdc92d3e1103710995c4
 SHA512:
-  metadata.gz: 01f96e0383d3f826f6746f8a191f32edde871470015da56dcdc0a3871aaeee357a66b846ae27f4c1a8ad35aa82207333d96e12bba00a02bbc0c5a3f52cc73f5a
-  data.tar.gz: 8d5a49b7702dae5b8e23617f11c03157c20eefc07857a156ee4c93df8e7429dcbb3ebbd6684230dd42e9b4ab149b3964a5e9933cda4bf4c5a1c95036346a460b
+  metadata.gz: 801697a0c78ee32edc0925e5bcf46efed24b91ae5404dd633c98a27dea80db4983c2634a1743983d8a6e310d73937b2c5a0aaa4808f8088d3fb5a5052577fcc8
+  data.tar.gz: 1a046d96ed17805e20928e60cceb8607d34055a7cd4b67bf4cacea3d80ded1d9c2044be480d21f4e21b92fe16b57a1653a21897b36d66244c440dfe0e1106bda

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.5.3 - 2026-01-07
+
+### Fixed
+
+- Ensure `BitAttr` internal integer is always up to date.
+- Clean up yard doc.
+
+### Removed
+
+- Remove support for Ruby < 3.1
+
 ## 0.5.2 - 2025-08-14
 
 ### Fixed

data/README.md

@@ -1,9 +1,9 @@
 [![Gem Version](https://badge.fury.io/rb/bin_struct.svg)](https://badge.fury.io/rb/bin_struct)
-[![Specs](https://github.com/lemontree55/bin_struct/actions/workflows/main.yml/badge.svg)](https://github.com/lemontree55/bin_struct/actions/workflows/main.yml)
+[![status-badge](https://ci.codeberg.org/api/badges/15063/status.svg)](https://ci.codeberg.org/repos/15063)
 
 # BinStruct
 
-BinStruct provides a simple way to create and dissect binary data. It is an extraction from [PacketGen](https://github.com/lemontree55/packetgen) 3.x Fields.
+BinStruct provides a simple way to create and dissect binary data. It is an extraction from [PacketGen](https://codeberg.org/lemontree55/packetgen) 3.x Fields.
 
 ## Installation
 

data/lib/bin_struct/abstract_tlv.rb

@@ -74,12 +74,13 @@ module BinStruct
       # rubocop:disable Metrics/ParameterLists
 
       # Generate a TLV class
-      # @param [Class] type_class Class to use for +type+
-      # @param [Class] length_class Class to use for +length+
-      # @param [Class] value_class Class to use for +value+
-      # @param [::String] attr_order gives attribute order. Each character in [T,L,V] MUST be present once,
+      # @param type_class [Class] Class to use for +type+
+      # @param length_class [Class] Class to use for +length+
+      # @param value_class [Class] Class to use for +value+
+      # @param aliases [Hash{Symbol=>Symbol}] define aliases with key an alias to an existing accessor (the value)
+      # @param attr_order [::String] gives attribute order. Each character in [T,L,V] MUST be present once,
       #   in the desired order.
-      # @param [::String] attr_in_length give attributes to compute length on.
+      # @param attr_in_length [::String] give attributes to compute length on.
       # @return [Class]
       # @raise [Error] Called on {AbstractTLV} subclass
       def create(type_class: Int8Enum, length_class: Int8, value_class: String,
@@ -109,7 +110,7 @@ module BinStruct
       # rubocop:enable Metrics/ParameterLists
 
       # On inheritage, copy aliases and attr_in_length
-      # @param [Class] klass inheriting class
+      # @param klass [Class] inheriting class
       # @return [void]
       # @since 0.4.0
       # @author LemonTree55
@@ -126,9 +127,10 @@ module BinStruct
       end
 
       # Derive a new TLV class from an existing one
-      # @param [Class,nil] type_class New class to use for +type+. Unchanged if +nil+.
-      # @param [Class,nil] length_class New class to use for +length+. Unchanged if +nil+.
-      # @param [Class,nil] value_class New class to use for +value+. Unchanged if +nil+.
+      # @param type_class [Class,nil] New class to use for +type+. Unchanged if +nil+.
+      # @param length_class [Class,nil] New class to use for +length+. Unchanged if +nil+.
+      # @param value_class [Class,nil] New class to use for +value+. Unchanged if +nil+.
+      # @param aliases [Hash{Symbol=>Symbol}] define aliases with key an alias to an existing accessor (the value)
       # @return [Class]
       # @raise [Error] Called on {AbstractTLV} class
       # @since 0.4.0
@@ -167,7 +169,7 @@ module BinStruct
 
       # @abstract Should only be called on real TLV classes, created by {.create}.
       # Set enum hash for {#type} attribute.
-      # @param [Hash{::String, Symbol => Integer}] hsh enum hash
+      # @param hsh [Hash{::String, Symbol => Integer}] enum hash
       # @return [void]
       def define_type_enum(hsh)
         attr_defs[:type][:options][:enum].clear
@@ -176,7 +178,7 @@ module BinStruct
 
       # @abstract Should only be called on real TLV classes, created by {.create}.
       # Set default value for {#type} attribute.
-      # @param [Integer,::String,Symbol,nil] default default value from +hsh+ for type
+      # @param default [Integer,::String,Symbol,nil] default value from +hsh+ for type
       # @return [void]
       def define_type_default(default)
         attr_defs[:type][:default] = default
@@ -184,12 +186,19 @@ module BinStruct
 
       private
 
+      # Check +attr_in_length+ and raise if it contains unknown characters
+      # @param attr_in_length [::String]
+      # @return [void]
+      # @raise [Error] +attr_in_length+ contains unsupported characters
       def check_attr_in_length(attr_in_length)
         return if /^[TLV]{1,3}$/.match?(attr_in_length)
 
-        raise 'attr_in_length must only contain T, L and/or V characters'
+        raise Error, 'attr_in_length must only contain T, L and/or V characters'
       end
 
+      # @param attr_order [::String]
+      # @return [void]
+      # @raise [Error] +attr_order+ contains unsupported characters
       def check_attr_order(attr_order)
         if attr_order.match(/^[TLV]{3,3}$/) &&
            (attr_order[0] != attr_order[1]) &&
@@ -198,9 +207,16 @@ module BinStruct
           return
         end
 
-        raise 'attr_order must contain all three letters TLV, each once'
+        raise Error, 'attr_order must contain all three letters TLV, each once'
       end
 
+      # Set TLV classes and order on +klass+
+      # @param klass [Class]
+      # @param attr_order [::String]
+      # @param type_class [Class]
+      # @param length_class [Class]
+      # @param value_class [Class]
+      # @return [AbstractTLV]
       def generate_attributes(klass, attr_order, type_class, length_class, value_class)
         attr_order.each_char do |attr_type|
           case attr_type
@@ -218,6 +234,10 @@ module BinStruct
         end
       end
 
+      # Define given +aliases+ on +klass+
+      # @param klass [Class]
+      # @param aliases [Hash{Symbol=>Symbol}]
+      # @return [void]
       def generate_aliases_for(klass, aliases)
         aliases.each do |al, orig|
           klass.instance_eval do
@@ -243,7 +263,7 @@ module BinStruct
 
     # @abstract Should only be called on real TLV classes, created by {.create}.
     # Return a new instance of a real TLV class.
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :type
     # @option options [Integer] :length
     # @option options [Object] :value
@@ -261,12 +281,13 @@ module BinStruct
 
     # @abstract Should only be called on real TLV class instances.
     # Populate object from a binary string
-    # @param [::String,nil] str
+    # @param str [::String,nil]
     # @return [AbstractTLV] self
     def read(str)
       return self if str.nil?
 
       idx = 0
+      str = str.b
       attributes.each do |attr_name|
         attr = self[attr_name]
         length = attr_name == :value ? real_length : attr.sz
@@ -279,7 +300,7 @@ module BinStruct
 
     # @abstract Should only be called on real TLV class instances.
     # Set +value+. May set +length+ if value is a {Types::String}.
-    # @param [Object] val
+    # @param val [Object]
     # @return [Object]
     def value=(val)
       if val.is_a?(self[:value].class)
@@ -320,6 +341,8 @@ module BinStruct
 
     private
 
+    # Compute length to set in length attribute
+    # @return [::Integer]
     def real_length
       length = self.length
       length -= self[:type].sz if @attr_in_length.include?('T')

data/lib/bin_struct/array.rb

@@ -39,7 +39,7 @@ module BinStruct
 
     # @!method [](index)
     #   Return the element at +index+.
-    #   @param [Integer] index
+    #   @param index [Integer]
     #   @return [Object]
     # @!method clear
     #   Clear array.
@@ -77,7 +77,7 @@ module BinStruct
       end
 
       # Define type of objects in set. Used by {#read} and {#push}.
-      # @param [Class] klass
+      # @param klass [Class]
       # @return [void]
       def set_of(klass)
         @klass = klass
@@ -85,7 +85,7 @@ module BinStruct
     end
     # rubocop:enable Naming/AccessorMethodName
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Int] counter Int object used as a counter for this set
     # @example counter example
     #   # Define a counter
@@ -113,11 +113,12 @@ module BinStruct
     # Initialize array for copy:
     # * duplicate internal array.
     # @note Associated counter, if any, is not duplicated
-    def initialize_copy(_other)
+    def initialize_copy(*)
       @array = @array.dup
     end
 
     # Check equality. Equality is checked on underlying array.
+    # @param other [Object]
     # @return [Boolean]
     def ==(other)
       @array == case other
@@ -137,7 +138,7 @@ module BinStruct
     end
 
     # Delete an object from this array. Update associated counter if any
-    # @param [Object] obj
+    # @param obj [Object]
     # @return [Object] deleted object
     def delete(obj)
       deleted = @array.delete(obj)
@@ -146,7 +147,7 @@ module BinStruct
     end
 
     # Delete element at +index+. Update associated counter if any
-    # @param [Integer] index
+    # @param index [Integer]
     # @return [Object,nil] deleted object
     def delete_at(index)
       deleted = @array.delete_at(index)
@@ -158,7 +159,7 @@ module BinStruct
     #   declared by subclasses.
     # Add an object to this array. Do not update associated counter. If associated must be incremented, use
     # {#<<}
-    # @param [Object] obj type depends on subclass
+    # @param obj [Object] type depends on subclass
     # @return [self]
     # @see #<<
     def push(obj)
@@ -176,7 +177,7 @@ module BinStruct
     #   declared by subclasses.
     # Add an object to this array, and increment associated counter, if any. If associated counter must not be
     # incremented, use {#push}.
-    # @param [Object] obj type depends on subclass
+    # @param obj [Object] type depends on subclass
     # @return [self]
     # @see #push
     def <<(obj)
@@ -186,7 +187,7 @@ module BinStruct
     end
 
     # Populate object from a string or from an array of hashes
-    # @param [::String, ::Array<Hash>] data
+    # @param data [::String, ::Array<Hash>]
     # @return [self]
     def read(data)
       clear
@@ -227,6 +228,8 @@ module BinStruct
 
     # rubocop:disable Metrics/CyclomaticComplexity
 
+    # @param str [::String]
+    # @return [void]
     def read_from_string(str)
       return self if str.nil? || @counter&.to_i&.zero?
 
@@ -239,6 +242,8 @@ module BinStruct
     end
     # rubocop:enable Metrics/CyclomaticComplexity
 
+    # @param ary [::Array<Hash{Symbol=>Object}>]
+    # @return [void]
     def read_from_array(ary)
       return self if ary.empty?
 
@@ -247,6 +252,11 @@ module BinStruct
       end
     end
 
+    # @abstract Subclasses may override this method to customize {#<<}, {#push} and {#read}.
+    #   A  default implementation is provided.
+    # This method instanciate a {.set_of_klass} object from +hsh+.
+    # @param hsh [Hash{Symbol=>Object}]
+    # @return [Object] an object of (sub)class {.set_of_klass}
     def record_from_hash(hsh)
       obj_klass = self.class.set_of_klass
       unless obj_klass
@@ -254,15 +264,25 @@ module BinStruct
               'class should define #record_from_hash or declare type of elements in set with .set_of'
       end
 
-      obj = obj_klass.new(hsh) if obj_klass
+      obj = obj_klass.new(hsh)
       klass = real_type(obj)
       klass == obj_klass ? obj : klass.new(hsh)
     end
 
+    # @abstract Subclasses may override thi method to customize {#<<}, {#push} and {#read}.
+    #   A default implementation is provided.
+    # Return real type for +_obj+. Here, always return {.set_of_klass}.
+    # @param _obj [Object] not used here but may be by subclasses
+    # @return [Object] an object of class {.set_of_class}
     def real_type(_obj)
       self.class.set_of_klass
     end
 
+    # @abstract Subclasses may override thi method to customize {#<<}, {#push} and {#read}.
+    #   A default implementation is provided.
+    # Instanicate an object to put in self from a String
+    # @param str [::String] not used here but may be by subclasses
+    # @return [Object] an object of class {.set_of_class}
     def create_object_from_str(str)
       klass = self.class.set_of_klass
       obj = klass.new.read(str)
@@ -277,17 +297,22 @@ module BinStruct
   end
 
   # @private
+  # Mixin to define common methods to all +ArrayOfInt*+ classes.
   module ArrayOfIntMixin
+    # Read data from an Array and instanciate an {Int} type (from {.set_of_klass}) for each element and put it in self.
+    # @param ary [::Array<Integer>]
+    # @return [void]
     def read_from_array(ary)
       return self if ary.empty?
 
+      inner_klass = self.class.set_of_klass
       ary.each do |i|
-        self << self.class.set_of_klass.new(value: i)
+        self << inner_klass.new(value: i)
       end
     end
   end
 
-  # Specialized {Array} to handle serie of {Int8}.
+  # Specialized {Array} to handle series of {Int8}.
   # @example
   #   ary = BinStruct::ArrayOfInt8.new
   #   ary.read([0, 1, 2])
@@ -297,10 +322,11 @@ module BinStruct
   #   ary.map(&:to_i) #=> [5, 6]
   class ArrayOfInt8 < Array
     include ArrayOfIntMixin
+
     set_of Int8
   end
 
-  # Specialized {Array} to handle serie of {Int16}.
+  # Specialized {Array} to handle series of {Int16}.
   # @example
   #   ary = BinStruct::ArrayOfInt16.new
   #   ary.read([0, 1, 2])
@@ -310,10 +336,11 @@ module BinStruct
   #   ary.map(&:to_i) #=> [0x0506]
   class ArrayOfInt16 < Array
     include ArrayOfIntMixin
+
     set_of Int16
   end
 
-  # Specialized {Array} to handle serie of {Int16le}.
+  # Specialized {Array} to handle series of {Int16le}.
   # @example
   #   ary = BinStruct::ArrayOfInt16le.new
   #   ary.read([0, 1, 2])
@@ -323,10 +350,11 @@ module BinStruct
   #   ary.map(&:to_i) #=> [0x0605]
   class ArrayOfInt16le < Array
     include ArrayOfIntMixin
+
     set_of Int16le
   end
 
-  # Specialized {Array} to handle serie of {Int32}.
+  # Specialized {Array} to handle series of {Int32}.
   # @example
   #   ary = BinStruct::ArrayOfInt32.new
   #   ary.read([0, 1, 2])
@@ -336,10 +364,11 @@ module BinStruct
   #   ary.map(&:to_i) #=> [0x00000506]
   class ArrayOfInt32 < BinStruct::Array
     include ArrayOfIntMixin
+
     set_of Int32
   end
 
-  # Specialized {Array} to handle serie of {Int32le}.
+  # Specialized {Array} to handle series of {Int32le}.
   # @example
   #   ary = BinStruct::ArrayOfInt32le.new
   #   ary.read([0, 1, 2])
@@ -349,6 +378,7 @@ module BinStruct
   #   ary.map(&:to_i) #=> [0x06050000]
   class ArrayOfInt32le < BinStruct::Array
     include ArrayOfIntMixin
+
     set_of Int32le
   end
 end

data/lib/bin_struct/bit_attr.rb

@@ -34,6 +34,7 @@ module BinStruct
     attr_reader :width
 
     # @private
+    # @todo Ruby 3.2: replace Struct by Data
     Parameters = Struct.new(:width, :fields, :int)
 
     class << self
@@ -44,13 +45,13 @@ module BinStruct
       attr_reader :parameters
 
       # @private
-      # @return [::Array[Symbol]]
+      # @return [::Array<Symbol>]
       attr_reader :bit_methods
 
       # Create a new {BitAttr} subclass with specified parameters
-      # @param [Integer] width size of bitfields in bits. Must be a size of an {Int} (8, 16, 24, 32 or 64 bits).
-      # @param [:big,:little,:native] endian endianess of bit attribute as an integer
-      # @param [Hash{Symbol=>Integer}] fields hash associating field names with their size. Total size MUST be equal
+      # @param width [Integer] size of bitfields in bits. Must be a size of an {Int} (8, 16, 24, 32 or 64 bits).
+      # @param endian [Symbol] endianess of bit attribute as an integer (:big, :little or :native)
+      # @param fields [Hash{Symbol=>Integer}] hash associating field names with their size. Total size MUST be equal
       #    to +width+.
       # @return [Class]
       # @raise [ArgumentError] raise if:
@@ -78,12 +79,16 @@ module BinStruct
         @cache = {}
       end
 
-      # @param [::Array] params
+      # @param params [::Array]
       # @return [::String]
       def compute_hash(*params)
         Digest::MD5.digest(Marshal.dump(params))
       end
 
+      # @param width [::Integer]
+      # @param endian [Symbol] :little,:big or:native
+      # @param fields [Hash{Symbol=>Integer}]
+      # @return [Class] subclass of {BitAttr} with given parameters
       def create_subclass(width, endian, fields)
         klass = Class.new(self) do
           int_klass = BinStruct.const_get("Int#{width}")
@@ -95,8 +100,8 @@ module BinStruct
         klass
       end
 
-      # @param [Class] {BitAttr} subclass
-      # @param [Hash{Symbol => Integer}] fields
+      # @param klass [Class] {BitAttr} subclass
+      # @param fields [Hash{Symbol => Integer}]
       # @return [void]
       def define_methods(klass, fields)
         define_str = +''
@@ -109,9 +114,9 @@ module BinStruct
             define_str << "def #{name}?; @data[#{name.inspect}] != 0; end\n"
             klass.bit_methods << :"#{name}?"
             define_str << "def #{name}=(val); v = case val when TrueClass; 1 when FalseClass; 0 else val end; " \
-                          "@data[#{name.inspect}] = v; end\n"
+                          "@data[#{name.inspect}] = v; @int.value = compute_integer; end\n"
           else
-            define_str << "def #{name}=(val); @data[#{name.inspect}] = val; end\n"
+            define_str << "def #{name}=(val); @data[#{name.inspect}] = val; @int.value = compute_integer; end\n"
           end
         end
         klass.class_eval(define_str)
@@ -119,11 +124,11 @@ module BinStruct
     end
 
     # Initialize bit attribute
-    # @param [Hash{Symbol=>Integer}] opts initialization values for fields, where keys are field names and values are
+    # @param values [Hash{Symbol=>Integer}] initialization values for fields, where keys are field names and values are
     #     initialization values
     # @return [self]
     # @raise [NotImplementedError] raised when called on {BitAttr} class
-    def initialize(opts = {})
+    def initialize(values = {})
       parameters = self.class.parameters
       raise NotImplementedError, "#initialize may only be called on subclass of #{self.class}" if parameters.nil?
 
@@ -131,19 +136,19 @@ module BinStruct
       @fields = parameters.fields
       @int = parameters.int.dup
       @data = {}
-      @bit_methods = []
 
       parameters.fields.each_key do |name|
-        @data[name] = opts[name] || 0
+        @data[name] = values[name] || 0
       end
-      @bit_methods.freeze
+      @int.value = compute_integer
     end
 
-    def initialize_copy(_other)
+    # Dup internal @data hash
+    def initialize_copy(*)
       @data = @data.dup
     end
 
-    # @return [::Array[Symbol]]
+    # @return [::Array<Symbol>]
     def bit_methods
       self.class.bit_methods
     end
@@ -162,7 +167,7 @@ module BinStruct
     end
 
     # Populate bit attribute from +str+
-    # @param [#to_s,nil] str
+    # @param str [#to_s,nil]
     # @return [self]
     def read(str)
       return self if str.nil?
@@ -174,30 +179,26 @@ module BinStruct
     # Give integer associated to this attribute
     # @return [Integer]
     def to_i
-      v = 0
-      @fields.each do |name, size|
-        v <<= size
-        v |= @data[name]
-      end
-
-      v
+      @int.to_i
     end
     alias to_human to_i
 
     # Return binary string
     # @return [::String]
     def to_s
-      @int.value = to_i
       @int.to_s
     end
 
     # Set fields from associated integer
-    # @param [#to_i] value
+    # @param value [#to_i]
     # @return [self]
     def from_human(value)
-      compute_data(value.to_i)
+      ivalue = value.to_i
+      @int.value = ivalue
+      compute_data(ivalue)
     end
 
+    # @return [::String]
     def format_inspect
       str = @int.format_inspect << "\n"
       str << @data.map { |name, value| "#{name}:#{value}" }.join(' ')
@@ -205,7 +206,7 @@ module BinStruct
 
     private
 
-    # @param [Integer] value
+    # @param value [Integer]
     # @return [self]
     def compute_data(value)
       @fields.reverse_each do |name, size|
@@ -215,5 +216,17 @@ module BinStruct
 
       self
     end
+
+    # Compute integer from fields
+    # @return [Integer]
+    def compute_integer
+      v = 0
+      @fields.each do |name, size|
+        v <<= size
+        v |= @data[name]
+      end
+
+      v
+    end
   end
 end

data/lib/bin_struct/cstring.rb

@@ -22,11 +22,11 @@ module BinStruct
     # @!method [](index)
     #   @overload [](index)
     #     Return the character at +index+.
-    #     @param [Integer] index
+    #     @param index [Integer]
     #   @overload [](start, length)
     #     Return the substring starting at +start+ with +length+ length.
-    #     @param [Integer] start
-    #     @param [Integer] length
+    #     @param start [Integer]
+    #     @param length [Integer]
     #   @return [::String,nil]
     # @!method length
     #   Return string length (without null-terminator)
@@ -49,8 +49,8 @@ module BinStruct
     #   @return [Encoding]
     # @!method index(substring, offset = 0)
     #   Returns the Integer index of the first occurrence of the given substring, or +nil+ if none found.
-    #   @param [::String] substring
-    #   @param [Integer] offset
+    #   @param substring [::String]
+    #   @param offset [Integer]
     #   @return [Integer,nil]
     # @!method empty?
     #   Return +true+ is string is empty.
@@ -77,7 +77,7 @@ module BinStruct
     # @return [Integer,nil]
     attr_reader :static_length
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :static_length set a static length for this string
     # @option options [::String] :value string value (default to +""+)
     def initialize(options = {})
@@ -86,12 +86,12 @@ module BinStruct
     end
 
     # Populate self from binary string
-    # @param [#to_s] str
+    # @param str [#to_s]
     # @return [self]
     def read(str)
       s = str.to_s
       s = s[0, static_length] if static_length?
-      register_internal_string s
+      register_internal_string(s)
       remove_null_character
       self
     end
@@ -109,10 +109,10 @@ module BinStruct
     end
 
     # Append the given string to CString
-    # @param [#to_s] str
+    # @param str [#to_s]
     # @return [self]
     def <<(str)
-      @string << str.to_s
+      @string << str.to_s.b
       remove_null_character
       self
     end
@@ -134,7 +134,7 @@ module BinStruct
     end
 
     # Populate CString from a human readable string
-    # @param [::String] str
+    # @param str [::String]
     # @return [self]
     def from_human(str)
       read(str)
@@ -148,12 +148,15 @@ module BinStruct
 
     private
 
+    # @param str [::String]
+    # @return [void]
     def register_internal_string(str)
       @string = str.b
     end
 
+    # @return [void]
     def remove_null_character
-      idx = string.index(0.chr)
+      idx = string.index("\0")
       register_internal_string(string[0, idx]) unless idx.nil?
     end
   end