Public Member Functions | Static Public Attributes | Friends | List of all members
SHA1Digest Class Reference

The SHA1 message digest. More...

Collaboration diagram for SHA1Digest:
[legend]

Public Member Functions

 SHA1Digest ()
 Default construct a zero digest. More...
 
 SHA1Digest (Istream &is)
 Read construct 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...
 
Istream & read (Istream &is)
 Read (40-byte) text representation. More...
 
Ostream & write (Ostream &os, const bool prefixed=false) const
 Write (40-byte) text representation, optionally with '_' prefix. More...
 
bool operator== (const SHA1Digest &rhs) 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 &rhs) 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 SHA1Digest null
 A null digest (ie, all zero) More...
 

Friends

class SHA1
 

Detailed Description

The SHA1 message digest.

See also
Foam::SHA1
Source files

Definition at line 60 of file SHA1Digest.H.

Constructor & Destructor Documentation

◆ SHA1Digest() [1/2]

SHA1Digest ( )

Default construct a zero digest.

Definition at line 111 of file SHA1Digest.C.

References clear().

Here is the call graph for this function:

◆ SHA1Digest() [2/2]

SHA1Digest ( Istream &  is)
explicit

Read construct a digest.

Definition at line 117 of file SHA1Digest.C.

References clear(), and Foam::read().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void clear ( )

Reset the digest to zero.

Definition at line 126 of file SHA1Digest.C.

◆ empty()

bool empty ( ) const

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

Definition at line 132 of file SHA1Digest.C.

◆ str()

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

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

Definition at line 161 of file SHA1Digest.C.

References hexChars.

◆ read()

Foam::Istream & read ( Istream &  is)

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.

Definition at line 146 of file SHA1Digest.C.

References IOstream::check(), FUNCTION_NAME, and Foam::readHexDigit().

Referenced by Foam::operator>>().

Here is the call graph for this function:
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 186 of file SHA1Digest.C.

References IOstream::check(), FUNCTION_NAME, hexChars, os(), and OBJstream::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 206 of file SHA1Digest.C.

◆ 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 212 of file SHA1Digest.C.

◆ 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 224 of file SHA1Digest.C.

◆ operator!=() [1/3]

bool operator!= ( const SHA1Digest &  rhs) const

Inequality operator.

Definition at line 236 of file SHA1Digest.C.

References Foam::operator==().

Here is the call graph for this function:

◆ operator!=() [2/3]

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

Inequality operator.

Definition at line 242 of file SHA1Digest.C.

References Foam::operator==().

Here is the call graph for this function:

◆ operator!=() [3/3]

bool operator!= ( const char *  hexdigits) const

Inequality operator.

Definition at line 248 of file SHA1Digest.C.

References Foam::operator==().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ SHA1

friend class SHA1
friend

Definition at line 80 of file SHA1Digest.H.

Member Data Documentation

◆ null

const Foam::SHA1Digest null
static

A null digest (ie, all zero)

Definition at line 88 of file SHA1Digest.H.

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