[][src]Struct fixed_hash::ApiDummy

#[repr(C)]
pub struct ApiDummy(pub [u8; 32]);

Go here for an overview of the hash type API.

Methods

impl ApiDummy[src]

pub fn repeat_byte(byte: u8) -> ApiDummy[src]

Returns a new fixed hash where all bits are set to the given byte.

pub fn zero() -> ApiDummy[src]

Returns a new zero-initialized fixed hash.

pub fn len_bytes() -> usize[src]

Returns the size of this hash in bytes.

pub fn as_bytes(&self) -> &[u8][src]

Extracts a byte slice containing the entire fixed hash.

pub fn as_bytes_mut(&mut self) -> &mut [u8][src]

Extracts a mutable byte slice containing the entire fixed hash.

pub fn as_fixed_bytes(&self) -> &[u8; 32][src]

Extracts a reference to the byte array containing the entire fixed hash.

pub fn as_fixed_bytes_mut(&mut self) -> &mut [u8; 32][src]

Extracts a reference to the byte array containing the entire fixed hash.

pub fn to_fixed_bytes(self) -> [u8; 32][src]

Returns the inner bytes array.

pub fn as_ptr(&self) -> *const u8[src]

Returns a constant raw pointer to the value.

pub fn as_mut_ptr(&mut self) -> *mut u8[src]

Returns a mutable raw pointer to the value.

pub fn assign_from_slice(&mut self, src: &[u8])[src]

Assign the bytes from the byte slice src to self.

Note

The given bytes are interpreted in big endian order.

Panics

If the length of src and the number of bytes in self do not match.

pub fn from_slice(src: &[u8]) -> Self[src]

Create a new fixed-hash from the given slice src.

Note

The given bytes are interpreted in big endian order.

Panics

If the length of src and the number of bytes in Self do not match.

pub fn covers(&self, b: &Self) -> bool[src]

Returns true if all bits set in b are also set in self.

pub fn is_zero(&self) -> bool[src]

Returns true if no bits are set.

impl ApiDummy[src]

Utilities using the byteorder crate.

pub fn to_low_u64_be(&self) -> u64[src]

Returns the lowest 8 bytes interpreted as big-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn to_low_u64_le(&self) -> u64[src]

Returns the lowest 8 bytes interpreted as little-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn to_low_u64_ne(&self) -> u64[src]

Returns the lowest 8 bytes interpreted as native-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn from_low_u64_be(val: u64) -> Self[src]

Creates a new hash type from the given u64 value.

Note

  • The given u64 value is interpreted as big endian.
  • Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

pub fn from_low_u64_le(val: u64) -> Self[src]

Creates a new hash type from the given u64 value.

Note

  • The given u64 value is interpreted as little endian.
  • Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

pub fn from_low_u64_ne(val: u64) -> Self[src]

Creates a new hash type from the given u64 value.

Note

  • The given u64 value is interpreted as native endian.
  • Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

impl ApiDummy[src]

Utilities using the rand crate.

pub fn randomize_using<R: ?Sized>(&mut self, rng: &mut R) where
    R: Rng
[src]

Assign self to a cryptographically random value using the given random number generator.

pub fn randomize(&mut self)[src]

Assign self to a cryptographically random value.

pub fn random_using<R: ?Sized>(rng: &mut R) -> Self where
    R: Rng
[src]

Create a new hash with cryptographically random content using the given random number generator.

pub fn random() -> Self[src]

Create a new hash with cryptographically random content.

Trait Implementations

impl AsMut<[u8]> for ApiDummy[src]

impl Copy for ApiDummy[src]

impl PartialEq<ApiDummy> for ApiDummy[src]

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests for !=.

impl AsRef<[u8]> for ApiDummy[src]

impl Default for ApiDummy[src]

impl Clone for ApiDummy[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Ord for ApiDummy[src]

fn max(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the minimum of two values. Read more

fn clamp(self, min: Self, max: Self) -> Self[src]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval. Read more

impl From<[u8; 32]> for ApiDummy[src]

fn from(bytes: [u8; 32]) -> Self[src]

Constructs a hash type from the given bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl<'a> From<&'a [u8; 32]> for ApiDummy[src]

fn from(bytes: &'a [u8; 32]) -> Self[src]

Constructs a hash type from the given reference to the bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl<'a> From<&'a mut [u8; 32]> for ApiDummy[src]

fn from(bytes: &'a mut [u8; 32]) -> Self[src]

Constructs a hash type from the given reference to the mutable bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl From<ApiDummy> for [u8; 32][src]

impl Eq for ApiDummy[src]

impl PartialOrd<ApiDummy> for ApiDummy[src]

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Display for ApiDummy[src]

impl Debug for ApiDummy[src]

impl<'l, 'r> BitAnd<&'r ApiDummy> for &'l ApiDummy[src]

type Output = ApiDummy

The resulting type after applying the & operator.

impl BitAnd<ApiDummy> for ApiDummy[src]

type Output = ApiDummy

The resulting type after applying the & operator.

impl<'l, 'r> BitOr<&'r ApiDummy> for &'l ApiDummy[src]

type Output = ApiDummy

The resulting type after applying the | operator.

impl BitOr<ApiDummy> for ApiDummy[src]

type Output = ApiDummy

The resulting type after applying the | operator.

impl<'l, 'r> BitXor<&'r ApiDummy> for &'l ApiDummy[src]

type Output = ApiDummy

The resulting type after applying the ^ operator.

impl BitXor<ApiDummy> for ApiDummy[src]

type Output = ApiDummy

The resulting type after applying the ^ operator.

impl<'r> BitAndAssign<&'r ApiDummy> for ApiDummy[src]

impl BitAndAssign<ApiDummy> for ApiDummy[src]

impl<'r> BitOrAssign<&'r ApiDummy> for ApiDummy[src]

impl BitOrAssign<ApiDummy> for ApiDummy[src]

impl<'r> BitXorAssign<&'r ApiDummy> for ApiDummy[src]

impl BitXorAssign<ApiDummy> for ApiDummy[src]

impl<I> Index<I> for ApiDummy where
    I: SliceIndex<[u8]>, 
[src]

type Output = I::Output

The returned type after indexing.

impl<I> IndexMut<I> for ApiDummy where
    I: SliceIndex<[u8], Output = [u8]>, 
[src]

impl Hash for ApiDummy[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

impl FromStr for ApiDummy[src]

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<ApiDummy, FromHexError>[src]

Creates a hash type instance from the given string.

Note

The given input string is interpreted in big endian.

Errors

  • When encountering invalid non hex-digits
  • Upon empty string input or invalid input length in general

impl LowerHex for ApiDummy[src]

impl UpperHex for ApiDummy[src]

impl HeapSizeOf for ApiDummy[src]

impl Distribution<ApiDummy> for Standard[src]

fn sample_iter<R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where
    R: Rng
[src]

Create an iterator that generates random values of T, using rng as the source of randomness. Read more

impl Arbitrary for ApiDummy[src]

fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static>[src]

Auto Trait Implementations

impl Send for ApiDummy

impl Sync for ApiDummy

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Rand for T where
    Standard: Distribution<T>, 
[src]