The SHA1 message digest. More...

Collaboration diagram for SHA1Digest:

Public Member Functions
	SHA1Digest ()
	Construct a zero digest. More...

	SHA1Digest (Istream &)
	Construct read a digest. More...

void	clear ()
	Reset the digest to zero. More...

bool	empty () const
	Return true if the digest is empty (ie, all zero). More...

std::string	str (const bool prefixed=false) const
	Return (40-byte) text representation, optionally with '_' prefix. More...

Ostream &	write (Ostream &, const bool prefixed=false) const
	Write (40-byte) text representation, optionally with '_' prefix. More...

bool	operator== (const SHA1Digest &) const
	Equality operator. More...

bool	operator== (const std::string &hexdigits) const
	Compare to (40-byte) text representation (eg, from sha1sum) More...

bool	operator== (const char *hexdigits) const
	Compare to (40-byte) text representation (eg, from sha1sum) More...

bool	operator!= (const SHA1Digest &) const
	Inequality operator. More...

bool	operator!= (const std::string &hexdigits) const
	Inequality operator. More...

bool	operator!= (const char *hexdigits) const
	Inequality operator. More...

Static Public Attributes
static const unsigned	length = 20
	The length of the (uncoded) digest contents. More...

static const SHA1Digest	null
	A null digest (ie, all zero) More...

Friends
class	SHA1

Istream &	operator>> (Istream &, SHA1Digest &)
	Read (40-byte) text representation. More...

Ostream &	operator<< (Ostream &, const SHA1Digest &)
	Write (40-byte) text representation, unquoted and without prefix. More...

Detailed Description

The SHA1 message digest.

See also: Foam::SHA1

Source files

Definition at line 62 of file SHA1Digest.H.

Constructor & Destructor Documentation

◆ SHA1Digest() [1/2]

SHA1Digest ( )

Construct a zero digest.

Definition at line 78 of file SHA1Digest.C.

References SHA1Digest::clear().

Here is the call graph for this function:

◆ SHA1Digest() [2/2]

SHA1Digest ( Istream & is )

Construct read a digest.

Definition at line 84 of file SHA1Digest.C.

Member Function Documentation

◆ clear()

void clear ( )

Reset the digest to zero.

Definition at line 92 of file SHA1Digest.C.

References SHA1Digest::length.

Referenced by SHA1Digest::SHA1Digest().

Here is the caller graph for this function:

◆ empty()

bool empty ( ) const

Return true if the digest is empty (ie, all zero).

Definition at line 98 of file SHA1Digest.C.

References SHA1Digest::length.

Referenced by SHA1Digest::operator==().

Here is the caller graph for this function:

◆ str()

std::string str ( const bool prefixed = false ) const

Return (40-byte) text representation, optionally with '_' prefix.

Definition at line 112 of file SHA1Digest.C.

References SHA1Digest::length.

Referenced by dynamicCode::reset(), and codedBase::updateLibrary().

Here is the caller graph for this function:

◆ write()

Foam::Ostream & write	(	Ostream &	os,
		const bool	prefixed = `false`
	)		const

Write (40-byte) text representation, optionally with '_' prefix.

Definition at line 137 of file SHA1Digest.C.

References IOstream::check(), SHA1Digest::length, and Ostream::write().

Referenced by Foam::operator<<(), and dynamicCode::writeDigest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==() [1/3]

bool operator== ( const SHA1Digest & rhs ) const

Equality operator.

Definition at line 157 of file SHA1Digest.C.

References SHA1Digest::length.

Referenced by SHA1Digest::operator!=().

Here is the caller graph for this function:

◆ operator==() [2/3]

bool operator== ( const std::string & hexdigits ) const

Compare to (40-byte) text representation (eg, from sha1sum)

An empty string is equivalent to "0000000000000000000000000000000000000000" The hexdigits may optionally start with a '_' prefix

Definition at line 171 of file SHA1Digest.C.

References Foam::constant::physicoChemical::c1, Foam::constant::physicoChemical::c2, SHA1Digest::empty(), and SHA1Digest::length.

Here is the call graph for this function:

◆ operator==() [3/3]

bool operator== ( const char * hexdigits ) const

Compare to (40-byte) text representation (eg, from sha1sum)

A null or empty string is equivalent to "0000000000000000000000000000000000000000" The hexdigits may optionally start with a '_' prefix

Definition at line 205 of file SHA1Digest.C.

References Foam::constant::physicoChemical::c1, Foam::constant::physicoChemical::c2, SHA1Digest::empty(), and SHA1Digest::length.

Here is the call graph for this function:

◆ operator!=() [1/3]

bool operator!= ( const SHA1Digest & rhs ) const

Inequality operator.

Definition at line 239 of file SHA1Digest.C.

References SHA1Digest::operator==().

Here is the call graph for this function:

◆ operator!=() [2/3]

bool operator!= ( const std::string & hexdigits ) const

Inequality operator.

Definition at line 245 of file SHA1Digest.C.

References SHA1Digest::operator==().

Here is the call graph for this function:

◆ operator!=() [3/3]

bool operator!= ( const char * hexdigits ) const

Inequality operator.

Definition at line 251 of file SHA1Digest.C.

References SHA1Digest::operator==().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ SHA1

friend class SHA1

friend

Definition at line 89 of file SHA1Digest.H.

◆ operator>>

Istream& operator>>	(	Istream &	,
		SHA1Digest &
	)

friend

Read (40-byte) text representation.

Since leading and intermediate underscores are skipped, a '_' can be prefixed to the text representation to use an unquoted SHA1Digest without parsing ambiguities as a number.

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const SHA1Digest &
	)

friend

Write (40-byte) text representation, unquoted and without prefix.

Member Data Documentation

◆ length

const unsigned length = 20

static

The length of the (uncoded) digest contents.

Definition at line 70 of file SHA1Digest.H.

Referenced by SHA1Digest::clear(), SHA1Digest::empty(), SHA1Digest::operator==(), Foam::operator>>(), SHA1Digest::str(), and SHA1Digest::write().

◆ null

const Foam::SHA1Digest null

static

A null digest (ie, all zero)

Definition at line 73 of file SHA1Digest.H.

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

src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.H
src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.C

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SHA1Digest() [1/2]

◆ SHA1Digest() [2/2]

Member Function Documentation

◆ clear()

◆ empty()

◆ str()

◆ write()

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

Friends And Related Function Documentation

◆ SHA1

◆ operator>>

◆ operator<<

Member Data Documentation

◆ length

◆ null