Ruby  3.4.0dev (2024-11-05 revision 348a53415339076afc4a02fcd09f3ae36e9c4c61)
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
25 #include "ruby/internal/value.h"
26 #include "ruby/st.h"
27 
29 
30 /* hash.c */
31 
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 
71 
83 void 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 
119 
127 VALUE rb_hash_dup(VALUE hash);
128 
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 
219 
230 
240 VALUE rb_hash_delete(VALUE hash, VALUE key);
241 
259 void rb_hash_bulk_insert(long argc, const VALUE *argv, VALUE hash);
260 
269 typedef VALUE rb_hash_update_func(VALUE newkey, VALUE oldkey, VALUE value);
270 
286 
287 /* file.c */
288 
297 int 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 
319 
320 #endif /* RBIMPL_INTERN_HASH_H */
Tweaking visibility of C variables/functions.
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition: dllexport.h:74
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition: dllexport.h:65
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:2954
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:4766
void rb_hash_foreach(VALUE hash, int(*func)(VALUE key, VALUE val, VALUE arg), VALUE arg)
Iterates over a hash.
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:1864
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...
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:2086
int rb_path_check(const char *path)
This function is mysterious.
Definition: file.c:6427
VALUE rb_hash_freeze(VALUE obj)
Just another name of rb_obj_freeze.
Definition: hash.c:108
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
VALUE rb_hash_delete(VALUE hash, VALUE key)
Deletes the passed key from the passed hash table, if any.
Definition: hash.c:2353
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:1503
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:2164
VALUE rb_hash_delete_if(VALUE hash)
Deletes each entry for which the block returns a truthy value.
Definition: hash.c:2516
VALUE rb_hash_update_by(VALUE hash1, VALUE hash2, rb_hash_update_func *func)
Destructively merges two hash tables into one.
Definition: hash.c:4021
VALUE rb_hash_aref(VALUE hash, VALUE key)
Queries the given key in the given hash table.
Definition: hash.c:2073
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:2893
VALUE rb_env_clear(void)
Destructively removes every environment variables of the running process.
Definition: hash.c:5825
VALUE rb_hash_lookup(VALUE hash, VALUE key)
Identical to rb_hash_aref(), except it always returns RUBY_Qnil for misshits.
Definition: hash.c:2099
VALUE rb_hash_dup(VALUE hash)
Duplicates a hash.
Definition: hash.c:1563
VALUE rb_hash(VALUE obj)
Calculates a message authentication code of the passed object.
Definition: hash.c:267
VALUE rb_hash_clear(VALUE hash)
Swipes everything out of the passed hash table.
Definition: hash.c:2820
VALUE rb_hash_new(void)
Creates a new, empty hash object.
Definition: hash.c:1475
int capa
Designed capacity of the buffer.
Definition: io.h:11
Defines RBIMPL_ATTR_NONNULL.
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition: nonnull.h:27
Definition: st.h:79
Defines VALUE and ID.
uintptr_t VALUE
Type that represents a Ruby object.
Definition: value.h:40