rdkafka 0.24.2-aarch64-linux-gnu → 0.25.1-aarch64-linux-gnu

data/lib/rdkafka/admin/delete_topic_handle.rb

@@ -2,11 +2,12 @@
 
 module Rdkafka
   class Admin
+    # Handle for delete topic operation
     class DeleteTopicHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :error_string, :pointer,
-             :result_name, :pointer
+        :response, :int,
+        :error_string, :pointer,
+        :result_name, :pointer
 
       # @return [String] the name of the operation
       def operation_name
@@ -18,10 +19,12 @@ module Rdkafka
         DeleteTopicReport.new(self[:error_string], self[:result_name])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: DeleteTopicReport.new(self[:error_string], self[:result_name]).error_string
+          self[:response],
+          broker_message: DeleteTopicReport.new(self[:error_string], self[:result_name]).error_string
         )
       end
     end

data/lib/rdkafka/admin/delete_topic_report.rb

@@ -2,6 +2,7 @@
 
 module Rdkafka
   class Admin
+    # Report for delete topic operation result
     class DeleteTopicReport
       # Any error message generated from the DeleteTopic
       # @return [String]
@@ -11,6 +12,8 @@ module Rdkafka
       # @return [String]
       attr_reader :result_name
 
+      # @param error_string [FFI::Pointer] pointer to error string
+      # @param result_name [FFI::Pointer] pointer to topic name
       def initialize(error_string, result_name)
         if error_string != FFI::Pointer::NULL
           @error_string = error_string.read_string

data/lib/rdkafka/admin/describe_acl_handle.rb

@@ -2,12 +2,13 @@
 
 module Rdkafka
   class Admin
+    # Handle for describe ACL operation
     class DescribeAclHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :response_string, :pointer,
-             :acls, :pointer,
-             :acls_count, :int
+        :response, :int,
+        :response_string, :pointer,
+        :acls, :pointer,
+        :acls_count, :int
 
       # @return [String] the name of the operation.
       def operation_name
@@ -19,10 +20,12 @@ module Rdkafka
         DescribeAclReport.new(acls: self[:acls], acls_count: self[:acls_count])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: self[:response_string].read_string
+          self[:response],
+          broker_message: self[:response_string].read_string
         )
       end
     end

data/lib/rdkafka/admin/describe_acl_report.rb

@@ -2,17 +2,19 @@
 
 module Rdkafka
   class Admin
+    # Report for describe ACL operation result
     class DescribeAclReport
-
       # acls that exists in the cluster for the resource_type, resource_name and pattern_type filters provided in the request.
       # @return [Rdkafka::Bindings::AclBindingResult] array of matching acls.
       attr_reader :acls
 
+      # @param acls [FFI::Pointer] pointer to ACLs array
+      # @param acls_count [Integer] number of ACLs
       def initialize(acls:, acls_count:)
-        @acls=[]
+        @acls = []
 
         if acls != FFI::Pointer::NULL
-          acl_binding_result_pointers  = acls.read_array_of_pointer(acls_count)
+          acl_binding_result_pointers = acls.read_array_of_pointer(acls_count)
           (1..acls_count).map do |acl_index|
             acl_binding_result = AclBindingResult.new(acl_binding_result_pointers[acl_index - 1])
             @acls << acl_binding_result

data/lib/rdkafka/admin/describe_configs_handle.rb

@@ -2,12 +2,13 @@
 
 module Rdkafka
   class Admin
+    # Handle for describe configs operation
     class DescribeConfigsHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :response_string, :pointer,
-             :config_entries, :pointer,
-             :entry_count, :int
+        :response, :int,
+        :response_string, :pointer,
+        :config_entries, :pointer,
+        :entry_count, :int
 
       # @return [String] the name of the operation.
       def operation_name
@@ -22,6 +23,8 @@ module Rdkafka
         )
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
           self[:response],

data/lib/rdkafka/admin/describe_configs_report.rb

@@ -2,11 +2,14 @@
 
 module Rdkafka
   class Admin
+    # Report for describe configs operation result
     class DescribeConfigsReport
       attr_reader :resources
 
+      # @param config_entries [FFI::Pointer] pointer to config entries array
+      # @param entry_count [Integer] number of config entries
       def initialize(config_entries:, entry_count:)
-        @resources=[]
+        @resources = []
 
         return if config_entries == FFI::Pointer::NULL
 
@@ -37,6 +40,9 @@ module Rdkafka
 
       private
 
+      # Validates the config resource result and raises an error if invalid
+      # @param config_resource_result_ptr [FFI::Pointer] pointer to the config resource result
+      # @raise [RdkafkaError] when the config resource has an error
       def validate!(config_resource_result_ptr)
         code = Bindings.rd_kafka_ConfigResource_error(config_resource_result_ptr)
 

data/lib/rdkafka/admin/incremental_alter_configs_handle.rb

@@ -2,12 +2,13 @@
 
 module Rdkafka
   class Admin
+    # Handle for incremental alter configs operation
     class IncrementalAlterConfigsHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :response_string, :pointer,
-             :config_entries, :pointer,
-             :entry_count, :int
+        :response, :int,
+        :response_string, :pointer,
+        :config_entries, :pointer,
+        :entry_count, :int
 
       # @return [String] the name of the operation.
       def operation_name
@@ -22,6 +23,8 @@ module Rdkafka
         )
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
           self[:response],

data/lib/rdkafka/admin/incremental_alter_configs_report.rb

@@ -2,11 +2,14 @@
 
 module Rdkafka
   class Admin
+    # Report for incremental alter configs operation result
     class IncrementalAlterConfigsReport
       attr_reader :resources
 
+      # @param config_entries [FFI::Pointer] pointer to config entries array
+      # @param entry_count [Integer] number of config entries
       def initialize(config_entries:, entry_count:)
-        @resources=[]
+        @resources = []
 
         return if config_entries == FFI::Pointer::NULL
 
@@ -37,6 +40,9 @@ module Rdkafka
 
       private
 
+      # Validates the config resource result and raises an error if invalid
+      # @param config_resource_result_ptr [FFI::Pointer] pointer to the config resource result
+      # @raise [RdkafkaError] when the config resource has an error
       def validate!(config_resource_result_ptr)
         code = Bindings.rd_kafka_ConfigResource_error(config_resource_result_ptr)