Struct harsh::HarshBuilder

pub struct HarshBuilder { /* fields omitted */ }

A builder used to configure and create a Harsh instance.

Implementations

impl HarshBuilder

pub fn new() -> HarshBuilder

Creates a new HarshBuilder instance.

pub fn salt<T: Into<Vec<u8>>>(self, salt: T) -> HarshBuilder

Provides a salt.

Note that this salt will be converted into a [u8] before use, meaning that multi-byte utf8 character values should be avoided.

pub fn alphabet<T: Into<Vec<u8>>>(self, alphabet: T) -> HarshBuilder

Provides an alphabet.

Note that this alphabet will be converted into a [u8] before use, meaning that multi-byte utf8 character values should be avoided. The alphabet must include at least sixteen characters.

pub fn separators<T: Into<Vec<u8>>>(self, separators: T) -> HarshBuilder

Provides a set of separators.

Note that these separators will be converted into a [u8] before use, meaning that multi-byte utf8 character values should be avoided.

pub fn length(self, hash_length: usize) -> HarshBuilder

Provides a minimum hash length.

Keep in mind that hashes produced may be longer than this length.

pub fn build(self) -> Result<Harsh, BuildError>

Initializes a new Harsh based on the HarshBuilder.

This method will consume the HarshBuilder.

Trait Implementations

impl Debug for HarshBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HarshBuilder

fn default() -> HarshBuilder

Returns the “default value” for a type.