Struct xpcom::interfaces::nsICryptoHash
[−]
[src]
#[repr(C)]pub struct nsICryptoHash { /* fields omitted */ }
interface nsICryptoHash : nsISupports
/**
* nsICryptoHash
* This interface provides crytographic hashing algorithms.
*/
Methods
impl nsICryptoHash
[src]
pub fn coerce<T: nsICryptoHashCoerce>(&self) -> &T
[src]
Cast this nsICryptoHash
to one of its base interfaces.
impl nsICryptoHash
[src]
pub const MD2: i64
MD2: i64 = 1
/**
* Hashing Algorithms. These values are to be used by the
* |init| method to indicate which hashing function to
* use. These values map directly onto the values defined
* in mozilla/security/nss/lib/cryptohi/hasht.h.
*/
pub const MD5: i64
MD5: i64 = 2
pub const SHA1: i64
SHA1: i64 = 3
pub const SHA256: i64
SHA256: i64 = 4
pub const SHA384: i64
SHA384: i64 = 5
pub const SHA512: i64
SHA512: i64 = 6
pub unsafe fn Init(&self, aAlgorithm: uint32_t) -> nsresult
[src]
/**
* Initialize the hashing object. This method may be
* called multiple times with different algorithm types.
*
* @param aAlgorithm the algorithm type to be used.
* This value must be one of the above valid
* algorithm types.
*
* @throws NS_ERROR_INVALID_ARG if an unsupported algorithm
* type is passed.
*
* NOTE: This method or initWithString must be called
* before any other method on this interface is called.
*/
void init (in unsigned long aAlgorithm);
pub unsafe fn InitWithString(&self, aAlgorithm: &nsACString) -> nsresult
[src]
/**
* Initialize the hashing object. This method may be
* called multiple times with different algorithm types.
*
* @param aAlgorithm the algorithm type to be used.
*
* @throws NS_ERROR_INVALID_ARG if an unsupported algorithm
* type is passed.
*
* NOTE: This method or init must be called before any
* other method on this interface is called.
*/
[must_use] void initWithString (in ACString aAlgorithm);
pub unsafe fn Update(&self, aData: *const uint8_t, aLen: uint32_t) -> nsresult
[src]
/**
* @param aData a buffer to calculate the hash over
*
* @param aLen the length of the buffer |aData|
*
* @throws NS_ERROR_NOT_INITIALIZED If |init| has not been called.
*/
void update ([array, size_is (aLen), const] in octet aData, in unsigned long aLen);
pub unsafe fn UpdateFromStream(
&self,
aStream: *const nsIInputStream,
aLen: uint32_t
) -> nsresult
[src]
&self,
aStream: *const nsIInputStream,
aLen: uint32_t
) -> nsresult
/**
* Calculates and updates a new hash based on a given data stream.
*
* @param aStream an input stream to read from.
*
* @param aLen How much to read from the given |aStream|. Passing UINT32_MAX
* indicates that all data available will be used to update the hash.
*
* @throws NS_ERROR_NOT_INITIALIZED If |init| has not been called.
*
* @throws NS_ERROR_NOT_AVAILABLE If the requested amount of
* data to be calculated into the hash is not available.
*
*/
[must_use] void updateFromStream (in nsIInputStream aStream, in unsigned long aLen);
pub unsafe fn Finish(&self, aASCII: bool, _retval: &mut nsACString) -> nsresult
[src]
/**
* Completes this hash object and produces the actual hash data.
*
* @param aASCII If true then the returned value is a base64 encoded string.
* If false, then the returned value is binary data.
*
* @return a hash of the data that was read by this object. This can
* be either binary data or base 64 encoded.
*
* @throws NS_ERROR_NOT_INITIALIZED If |init| has not been called.
*
* NOTE: This method may be called any time after |init|
* is called. This call resets the object to its
* pre-init state.
*/
ACString finish (in boolean aASCII);
Methods from Deref<Target = nsISupports>
pub fn coerce<T: nsISupportsCoerce>(&self) -> &T
[src]
Cast this nsISupports
to one of its base interfaces.
pub unsafe fn QueryInterface(
&self,
uuid: &nsIID,
result: *mut *mut c_void
) -> nsresult
[src]
&self,
uuid: &nsIID,
result: *mut *mut c_void
) -> nsresult
void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);
pub unsafe fn AddRef(&self) -> nsrefcnt
[src]
[noscript,notxpcom] nsrefcnt AddRef ();
pub unsafe fn Release(&self) -> nsrefcnt
[src]
[noscript,notxpcom] nsrefcnt Release ();
Trait Implementations
impl XpCom for nsICryptoHash
[src]
const IID: nsIID
IID: nsIID = nsID(509312067, 18056, 17870, [146, 225, 119, 237, 147, 30, 59, 190])
fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>
[src]
Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more
impl RefCounted for nsICryptoHash
[src]
unsafe fn addref(&self)
[src]
Increment the reference count.
unsafe fn release(&self)
[src]
Decrement the reference count, potentially freeing backing memory.
impl Deref for nsICryptoHash
[src]
type Target = nsISupports
The resulting type after dereferencing.
fn deref(&self) -> &nsISupports
[src]
Dereferences the value.