Module: Prosody::NativeScanOperations

Included in:
NativeJsonDequeScan, NativeJsonMapScan, NativeMapKeyScan, NativeMessageDequeScan, NativeMessageMapScan
Defined in:
lib/prosody/native_stubs.rb

Overview

Native cursor over a keyed-state collection, driven one chunk at a time by the MapState / DequeState traversal methods. Each pull crosses the bridge and yields the fiber; close is idempotent.

See Also:

  • for implementation

Instance Method Summary collapse

Instance Method Details

#close ⇒ void

This method returns an undefined value.

Closes the native cursor. Idempotent.

Raises:

  • (NotImplementedError) 


851
852
853
 
# File 'lib/prosody/native_stubs.rb', line 851

def close
  raise NotImplementedError, "This method is implemented natively in Rust"
end

#initialize ⇒ Object

Raises:

  • (NotImplementedError) 


837
838
839
 
# File 'lib/prosody/native_stubs.rb', line 837

def initialize
  raise NotImplementedError, "This class is implemented natively in Rust"
end

#next ⇒ Object?

Pulls the next item from the cursor.

Returns:

  • (Object, nil) —

    the next item, or nil when the cursor is exhausted

Raises:

  • (NotImplementedError) 


844
845
846
 
# File 'lib/prosody/native_stubs.rb', line 844

def next
  raise NotImplementedError, "This method is implemented natively in Rust"
end