docs/0.8/OFHash_8h_source.html

 /*

  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015

  *   Jonathan Schleifer <js@webkeks.org>

  *

  * All rights reserved.

  *

  * This file is part of ObjFW. It may be distributed under the terms of the

  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in

  * the packaging of this file.

  *

  * Alternatively, it may be distributed under the terms of the GNU General

  * Public License, either version 2 or 3, which can be found in the file

  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this

  * file.

  */


 #import "OFObject.h"


 OF_ASSUME_NONNULL_BEGIN


 @protocol OFHash <OFObject>

 #ifdef OF_HAVE_PROPERTIES

 @property (readonly, getter=isCalculated) bool calculated;

 #endif


 + (instancetype)hash;


 + (size_t)digestSize;


 + (size_t)blockSize;


 - (void)updateWithBuffer: (const void*)buffer

           length: (size_t)length;


 - (const uint8_t*)digest OF_RETURNS_INNER_POINTER;


 - (bool)isCalculated;


 - (void)reset;

 @end


 OF_ASSUME_NONNULL_END

+[OFHash-p hash]
instancetype hash()
Creates a new hash.

OFObject
The root class for all other classes inside ObjFW.
Definition: OFObject.h:364

+[OFHash-p digestSize]
size_t digestSize()
Returns the digest size of the hash, in bytes.

-[OFHash-p reset]
void reset()
Resets all state so that a new hash can be calculated.

OFHash-p
A protocol for classes providing hash functions.
Definition: OFHash.h:26

OFObject.h

-[OFHash-p digest]
const uint8_t * digest()
Returns a buffer containing the hash.

-[OFHash-p isCalculated]
bool isCalculated()
Returns a boolean whether the hash has already been calculated.

+[OFHash-p blockSize]
size_t blockSize()
Returns the block size of the hash, in bytes.