Ruby: include/ruby/internal/intern/hash.h Source File

Ruby 3.2.5p208 (2024-07-26 revision 31d0f1a2e7dbfb60731d1f05b868e1d578cda493)

hash.h
Go to the documentation of this file.
1#ifndef RBIMPL_INTERN_HASH_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_INTERN_HASH_H
23#include "ruby/internal/attr/nonnull.h"
24#include "ruby/internal/dllexport.h"
25#include "ruby/internal/value.h"
26#include "ruby/st.h"
27
28 RBIMPL_SYMBOL_EXPORT_BEGIN()
29
30/* hash.c */
31
32 RBIMPL_ATTR_NONNULL(())
48 void rb_st_foreach_safe(struct st_table *st, st_foreach_callback_func *func, st_data_t arg);
49
51#define st_foreach_safe rb_st_foreach_safe
52
70 VALUE rb_check_hash_type(VALUE obj);
71
72 RBIMPL_ATTR_NONNULL(())
83void rb_hash_foreach(VALUE hash, int (*func)(VALUE key, VALUE val, VALUE arg), VALUE arg);
84
100 VALUE rb_hash(VALUE obj);
101
107 VALUE rb_hash_new(void);
108
118 VALUE rb_hash_new_capa(long capa);
119
127 VALUE rb_hash_dup(VALUE hash);
128
130 VALUE rb_hash_freeze(VALUE obj);
131
142 VALUE rb_hash_aref(VALUE hash, VALUE key);
143
156 VALUE rb_hash_lookup(VALUE hash, VALUE key);
157
181 VALUE rb_hash_lookup2(VALUE hash, VALUE key, VALUE def);
182
193 VALUE rb_hash_fetch(VALUE hash, VALUE key);
194
208 VALUE rb_hash_aset(VALUE hash, VALUE key, VALUE val);
209
218 VALUE rb_hash_clear(VALUE hash);
219
229 VALUE rb_hash_delete_if(VALUE hash);
230
240 VALUE rb_hash_delete(VALUE hash, VALUE key);
241
259void rb_hash_bulk_insert(long argc, const VALUE *argv, VALUE hash);
260
269typedef VALUE rb_hash_update_func(VALUE newkey, VALUE oldkey, VALUE value);
270
285 VALUE rb_hash_update_by(VALUE hash1, VALUE hash2, rb_hash_update_func *func);
286
287/* file.c */
288
297int rb_path_check(const char *path);
298
299/* hash.c */
300
307 VALUE rb_env_clear(void);
308
316 VALUE rb_hash_size(VALUE hash);
317
318 RBIMPL_SYMBOL_EXPORT_END()
319
320#endif /* RBIMPL_INTERN_HASH_H */
dllexport.h
Tweaking visibility of C variables/functions.
RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:106
RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:97
rb_hash_size
VALUE rb_hash_size(VALUE hash)
Identical to RHASH_SIZE(), except it returns the size in Ruby's integer instead of C's.
Definition hash.c:3041
rb_hash_bulk_insert
void rb_hash_bulk_insert(long argc, const VALUE *argv, VALUE hash)
Inserts a list of key-value pairs into a hash table at once.
Definition hash.c:4815
rb_hash_foreach
void rb_hash_foreach(VALUE hash, int(*func)(VALUE key, VALUE val, VALUE arg), VALUE arg)
Iterates over a hash.
rb_check_hash_type
VALUE rb_check_hash_type(VALUE obj)
Try converting an object to its hash representation using its to_hash method, if any.
Definition hash.c:1943
rb_st_foreach_safe
void rb_st_foreach_safe(struct st_table *st, st_foreach_callback_func *func, st_data_t arg)
Identical to rb_st_foreach(), except it raises exceptions when the callback function tampers the tabl...
rb_hash_lookup2
VALUE rb_hash_lookup2(VALUE hash, VALUE key, VALUE def)
Identical to rb_hash_lookup(), except you can specify what to return on misshits.
Definition hash.c:2156
rb_path_check
int rb_path_check(const char *path)
This function is mysterious.
Definition file.c:6306
rb_hash_freeze
VALUE rb_hash_freeze(VALUE obj)
Just another name of rb_obj_freeze.
Definition hash.c:89
rb_hash_update_func
VALUE rb_hash_update_func(VALUE newkey, VALUE oldkey, VALUE value)
Type of callback functions to pass to rb_hash_update_by().
Definition hash.h:269
rb_hash_delete
VALUE rb_hash_delete(VALUE hash, VALUE key)
Deletes the passed key from the passed hash table, if any.
Definition hash.c:2423
rb_hash_new_capa
VALUE rb_hash_new_capa(long capa)
Identical to rb_hash_new(), except it additionally specifies how many keys it is expected to contain.
Definition hash.c:1601
rb_hash_fetch
VALUE rb_hash_fetch(VALUE hash, VALUE key)
Identical to rb_hash_lookup(), except it yields the (implicitly) passed block instead of returning RU...
Definition hash.c:2234
rb_hash_delete_if
VALUE rb_hash_delete_if(VALUE hash)
Deletes each entry for which the block returns a truthy value.
Definition hash.c:2586
rb_hash_update_by
VALUE rb_hash_update_by(VALUE hash1, VALUE hash2, rb_hash_update_func *func)
Destructively merges two hash tables into one.
Definition hash.c:4072
rb_hash_aref
VALUE rb_hash_aref(VALUE hash, VALUE key)
Queries the given key in the given hash table.
Definition hash.c:2143
rb_hash_aset
VALUE rb_hash_aset(VALUE hash, VALUE key, VALUE val)
Inserts or replaces ("upsert"s) the objects into the given hash table.
Definition hash.c:2969
rb_env_clear
VALUE rb_env_clear(void)
Destructively removes every environment variables of the running process.
Definition hash.c:5943
rb_hash_lookup
VALUE rb_hash_lookup(VALUE hash, VALUE key)
Identical to rb_hash_aref(), except it always returns RUBY_Qnil for misshits.
Definition hash.c:2169
rb_hash_dup
VALUE rb_hash_dup(VALUE hash)
Duplicates a hash.
Definition hash.c:1632
rb_hash
VALUE rb_hash(VALUE obj)
Calculates a message authentication code of the passed object.
Definition hash.c:231
rb_hash_clear
VALUE rb_hash_clear(VALUE hash)
Swipes everything out of the passed hash table.
Definition hash.c:2894
rb_hash_new
VALUE rb_hash_new(void)
Creates a new, empty hash object.
Definition hash.c:1570
nonnull.h
Defines RBIMPL_ATTR_NONNULL.
RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30
st_table
Definition st.h:79
value.h
Defines VALUE and ID.
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40