     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81

    // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use std::iter::repeat;

    /**
     * The Digest trait specifies an interface common to digest functions, such as SHA-1 and the SHA-2
     * family of digest functions.
     */
    pub trait Digest {
        /**
         * Provide message data.
         *
         * # Arguments
         *
         * * input - A vector of message data
         */
        fn input(&mut self, input: &[u8]);

        /**
         * Retrieve the digest result. This method may be called multiple times.
         *
         * # Arguments
         *
         * * out - the vector to hold the result. Must be large enough to contain output_bits().
         */
        fn result(&mut self, out: &mut [u8]);

        /**
         * Reset the digest. This method must be called after result() and before supplying more
         * data.
         */
        fn reset(&mut self);

        /**
         * Get the output size in bits.
         */
        fn output_bits(&self) -> usize;

        /**
         * Get the output size in bytes.
         */
        fn output_bytes(&self) -> usize {
            (self.output_bits() + 7) / 8
        }

        /**
         * Get the block size in bytes.
         */
        fn block_size(&self) -> usize;

        /**
         * Convenience function that feeds a string into a digest.
         *
         * # Arguments
         *
         * * `input` The string to feed into the digest
         */
        fn input_str(&mut self, input: &str) {
            self.input(input.as_bytes());
        }

        /**
         * Convenience function that retrieves the result of a digest as a
         * String in hexadecimal format.
         */
        fn result_str(&mut self) -> String {
            use serialize::hex::ToHex;

            let mut buf: Vec<u8> = repeat(0).take((self.output_bits()+7)/8).collect();
            self.result(&mut buf);
            buf[..].to_hex()
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)