Hash

Hash reference More...

Inherits Variable.

Public Types
using	Iterator = HashIterator
	Type alias.

Public Member Functions
	Hash (Perl &perl, HV *hv, bool increase_refcount)
	Constructor. More...
Hash elements
Hash &	insert (const std::string &key, const Scalar &value)
	Add element. More...
Hash &	insert (const std::pair< std::string, Scalar > &pair)
Hash &	insert (const std::unordered_map< std::string, Scalar > &hashmap)
Scalar	get (const std::string &key)
	Fetch element. More...
Scalar	remove (const std::string &key)
	Remove element and return. More...
Hash &	clear ()
	Remove all elements. More...
Misc
I32	getSize () const
	Elements count. More...
bool	isEmpty () const
	Check if hash is empty. More...
bool	isExists (const std::string &key) const
	Check element exists. More...
std::string	toString () const
	Convert to C++ string.
std::unordered_map< std::string, Scalar >	toMap () const
	Convert to C++ hash map.
Scalar	makeRef () const
	Take reference. More...
Hash	makeCopy () const
	Copy each element to new hash. More...
Iterator	begin () const
	Forward iterator.
Iterator	end () const
Internals
HV *	getHV () const
	Raw hash.
Operators
Scalar	operator[] (const std::string &key) noexcept
	Unsafe version of get()
Scalar	operator[] (const char *key) noexcept
	operator bool () const
	Alias to ! isEmpty()
Public Member Functions inherited from Variable
	Variable (Perl &perl, SV *sv, bool increase_refcount)
	Constructor.
	Variable (const Variable &to_copy)
	Copy constructor. More...
	Variable (Variable &&to_move)
	Move constructor. More...
virtual	~Variable ()
	Destructor. More...
void	setReadOnly (bool state)
	Add/remove readonly flag.
bool	isReadOnly () const
	Check if SV has readonly flag.
Perl &	getPerl () const
	Get Perl instance.
SV *	getSV () const
	Get raw scalar.
SV *	detachSV ()
	Nullify object and return SV. More...
SV *	detachMortalSV ()
	Nullify object and return mortalized SV. More...
U32	getRefcount () const
	Get SV reference count.
void	increaseRefcount ()
	Increase SV reference count.
void	decreaseRefcount ()
	Decrease SV reference count.
void	dump () const
	Dump SV data to stderr.
bool	operator== (const Variable &other)
	Compare SV pointers.
bool	operator!= (const Variable &other)

Detailed Description

Hash reference

Example

Hash hash = perl.newHash<IV>({ { "a", 1 }, { "b", 2} }); // (my) %hash = (a => 1, b => 2)
hash.insert("c", perl.newScalar(3));                     // $hash{c} = 3
Scalar a = hash.get("a").makeCopy();                     // $a = $hash{a}

Definition at line 22 of file hash.hpp.

Constructor & Destructor Documentation

Hash	(	Perl &	perl,
		HV *	hv,
		bool	increase_refcount
	)

Constructor.

Use Perl::newHash() instead

Definition at line 9 of file hash.cpp.

Member Function Documentation

Hash & insert	(	const std::string &	key,
		const Scalar &	value
	)

Add element.

Perl equivalent

$hash{key} = $scalar 

Definition at line 57 of file hash.cpp.

Scalar get

(

const std::string &

key

)

Fetch element.

Perl equivalent

$scalar = $hash{key} 

Exceptions

PerlException

Element not exists

Definition at line 31 of file hash.cpp.

Scalar remove

(

const std::string &

key

)

Remove element and return.

Perl equivalent

$scalar = delete $hash{key} 

Exceptions

PerlException

Element not exists

Definition at line 76 of file hash.cpp.

Hash & clear

(

)

Remove all elements.

Perl equivalent

%hash = () 

Definition at line 98 of file hash.cpp.

I32 getSize

(

)

const

Elements count.

Perl equivalent

scalar keys %hash 

Definition at line 16 of file hash.cpp.

bool isEmpty

(

)

const

Check if hash is empty.

Perl equivalent

scalar keys %hash 

Definition at line 21 of file hash.cpp.

bool isExists

(

const std::string &

key

)

const

Check element exists.

Perl equivalent

exists $hash{key} 

Definition at line 26 of file hash.cpp.

Scalar makeRef

(

)

const

Take reference.

Perl equivalent

$ref = \%hash 

Definition at line 138 of file hash.cpp.

Hash makeCopy

(

)

const

Copy each element to new hash.

Perl equivalent

%copy = %hash 

See also

Scalar::makeCopy()

Definition at line 143 of file hash.cpp.

---

The documentation for this class was generated from the following files:

• include/yobaperl/hash.hpp
• src/hash.cpp